jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Add example of subject folder listing (#34804)

Browse Source
This commit is contained in:
Kevin Heis
2023-02-16 08:10:33 -08:00
committed by GitHub
parent 5c1bd923ad
commit 3fbfe5627c
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/README.md
View File

@@ -10,6 +10,21 @@ We used to organize our code more by role: client, stylesheets, server middlewar
Run `script/create-subject.js --name x` to create a new subject folder. Run `script/create-subject.js --name x` to create a new subject folder.
Subjects do not need every element below. Not every element needs to be a folder. A subject folder looks similar to:
```
src/
xsubject/
README.md
components/
lib/
tests/
scripts/
stylesheets/
pages/
docs/
```
We compose subjects together like TBD - still a work in progress! We compose subjects together like TBD - still a work in progress!
How to declare a subject depends on another subject TBD - still a work in progress! How to declare a subject depends on another subject TBD - still a work in progress!