dwyl / mvp

📲 simplest version of the @dwyl app
https://mvp.fly.dev
GNU General Public License v2.0
84 stars 2 forks source link

Chore: Split `BUILDIT.md` into smaller more maintainable files #350

Open nelsonic opened 1 year ago

nelsonic commented 1 year ago

At present the BUILDIT.md is several thousand lines long: mvp-buildit-too-big

While it's great that we've collectively made an effort to document the MVP in such great detail. Having a single file this large makes it difficult to maintain and extend especially with the last section numbering being a bit of a moving target ...

mvp-buildit-run-finished-app-moving-target

Each time a new section is added before the "??. Run the Finished MVP App!" section, the number has to be incremented manually.

Proposal: shift the docs of the MVP from this repo to the /book repo.

Todo

Note: this is a priority-3 task. Only look at it once the features you're working on are complete. Docs are super important for capturing/sharing knowledge so they shouldn't be neglected. We are proactively writing great docs to encourage learning and contribution. Nobody reading the BUILDIT.md file has "complained" that it is "too long" ... But if we can get into the habit of extending the book repo with our docs we can gradually collectively write a book that other people can read to learn what we are building. 💭

nelsonic commented 1 year ago

Ref: https://dwyl.github.io/book/mvp/index.html

nelsonic commented 1 year ago

e.g: https://dwyl.github.io/book/mvp/16-lists.html