This Gist is structured to provide clear and maintainable documentation.
Instead of putting everything in one file, the documentation is split into multiple files:
- setup.md β step-by-step setup instructions
- config.yml β configuration template
- notes.md β explanations, troubleshooting, gotchas
- Start with setup.md to install and configure.
- Use config.yml as your base configuration.
- Refer to notes.md for troubleshooting and extra context.
- Easy to read and maintain.
- Reusable for future projects.
- Allows quick navigation without scrolling through one giant file.