Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update project structure documentation #785

Merged
merged 1 commit into from
Sep 26, 2022
Merged

Update project structure documentation #785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/portal-contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,12 @@ developer-portal
│ ├── 2021-01-07-january.md
│ ├── 2021-02-03-february.md
│ └── *.md
├── changelog
│ └── source
│ ├── 2021.8.0.md
│ ├── 2021.12.0.md
│ ├── 2021.16.0.md
│ └── *.md
├── docs
│ ├── fund-your-project
│ ├── get-started
Expand All @@ -142,6 +148,11 @@ developer-portal
│ ├── dotnet
│ ├── js
| └── python
├── scripts
│ ├── cip.ts
│ ├── rust-library.ts
│ ├── token-registry.ts
│ └── *.md
rphair marked this conversation as resolved.
Show resolved Hide resolved
├── src
│ ├── css
│ │ └── custom.css
Expand All @@ -167,8 +178,10 @@ developer-portal
### Project structure rundown

- `/blog/` - Contains the blog Markdown files for the developer spotlight.
- `/changelog/source/` - Contains the changelog data split by months into Markdown files.
- `/docs/` - Contains the Markdown files for the docs. Customize the order of the docs sidebar in `sidebars.js`.
- `/examples/` - Contains example projects for the Markdown files in the docs. *The structure is not final and will likely change in the future*
- `/scripts/` - Contains scripts to fetch auto generated content like CIPs, Rust Library, Token Registry.
- `/src/` - Non-documentation files like pages or custom React components. You don't have to strictly put your non-documentation files in here, but putting them under a centralized directory makes it easier to specify in case you need to do some sort of linting/processing.
- `/src/data/builder-tools` - Screenshots for the builder tools section.
- `/src/data/builder-tools.js` - Definition file for the builder tools section.
Expand Down