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.

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

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

Open
4 tasks
nelsonic opened this issue Apr 10, 2023 · 2 comments
Open
4 tasks

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

nelsonic opened this issue Apr 10, 2023 · 2 comments
Assignees
Labels
help wanted If you can help make progress with this issue, please comment! priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T2h Time Estimate 2 Hours tech-debt A feature/requirement implemented in a sub-optimal way & must be re-written technical A technical issue that requires understanding of the code, infrastructure or dependencies

Comments

@nelsonic
Copy link
Member

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

  • Create a new directory in the book project: /src/mvp
  • Split the mvp/BUILTIT.md file into separate files in the new directory
  • Link to the new mvp section (in "the book") from the mvp repo.

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 nelsonic added T2h Time Estimate 2 Hours technical A technical issue that requires understanding of the code, infrastructure or dependencies priority-3 Third priority. Considered "Nice to Have". Not urgent. tech-debt A feature/requirement implemented in a sub-optimal way & must be re-written labels Apr 10, 2023
@nelsonic nelsonic added priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished and removed priority-3 Third priority. Considered "Nice to Have". Not urgent. labels Apr 18, 2023
@nelsonic nelsonic self-assigned this Apr 18, 2023
@nelsonic
Copy link
Member Author

@nelsonic
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted If you can help make progress with this issue, please comment! priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T2h Time Estimate 2 Hours tech-debt A feature/requirement implemented in a sub-optimal way & must be re-written technical A technical issue that requires understanding of the code, infrastructure or dependencies
Projects
Status: 🏗 In progress
Development

No branches or pull requests

1 participant