📝 Documentation: Add DEVELOPMENT.md - Githubissues

LearningTypeScript / site

Companion website for the Learning TypeScript book.

https://learningtypescript.com

MIT License

48 stars 12 forks source link

📝 Documentation: Add DEVELOPMENT.md #40

Closed JoshuaKGoldberg closed 1 year ago

JoshuaKGoldberg commented 2 years ago

Documentation Report Checklist

[X] I have pulled the latest main branch of the repository.
[X] I have searched for related issues and found none that matched my request.
[X] This is the appropriate issue form for the documentation issue I would like to report.

Expected

Any good repository needs a DEVELOPMENT.md file to tell people how to get started! This repo in particular should also mention:

The general project structure
Important CI things
How it consumes the https://github.com/LearningTypeScript/projects repo with Git submodules
- Tip for an FAQs section: git submodule foreach git pull
- Tip for an FAQs section: If that fails, try git checkout main inside the submodule

Actual

Very little is documented now.

Additional Info

~Marking as blocked for now until the projects repo is more settled.~ ✅

Tip:

git checkout main; git pull; git submodule foreach git pull; git add -A; git commit -m "🔨 chore: updated src/content/external projects"; git push