Before opening a pull request
- Use focused commits with a clear scope
- Run formatting, type checks, and relevant tests
- Update docs when behavior or setup changes
- Keep product naming as “KeinSaaS Navigator”
Useful commands
Documentation standards
Write original docs for Navigator. It is fine to learn from the structure of other documentation sites, but do not copy or lightly rewrite another project’s text. When documenting a feature:1
Start from the actual behavior
Use the app, README, or implementation as the source of truth.
2
Show the user's path
Prefer setup steps, examples, and configuration snippets over generic marketing language.
3
Link related pages
Connect concept pages to setup guides so readers can act immediately.