might also be more relavant to be in flixel-docs repo but whateva!
Right now docs are organized by number, which works generally fine. However if you want to insert a doc in between two other docs, instead of appending to the docs list, you would have to rename all the filenames for the docs!
The folders and the markdown files are all organized / sorted by their number in their filename.
I think an alternative solution is something like the mdbookSUMMARY.md
With this, can organize the docs in a way where adding docs you wouldn't need to:
rename any files when adding new ones
add drafts easier (can add a draft without pushing it to the site)
be more intentional with placement and ordering of the docs
note: summary.md is just an example, for the site we might want a different (but just as easily modifiable) data file dedicated for docs organization/sorting
might also be more relavant to be in
flixel-docsrepo but whateva!Right now docs are organized by number, which works generally fine. However if you want to insert a doc in between two other docs, instead of appending to the docs list, you would have to rename all the filenames for the docs!
The folders and the markdown files are all organized / sorted by their number in their filename.
I think an alternative solution is something like the mdbook
SUMMARY.mdhttps://rust-lang.github.io/mdBook/format/summary.html
Example from the mdbook documentation itself: https://rust-lang.github.io/mdBook/format/summary.html#example
With this, can organize the docs in a way where adding docs you wouldn't need to:
note:
summary.mdis just an example, for the site we might want a different (but just as easily modifiable) data file dedicated for docs organization/sorting