Contributing
Contributing to the docs hub
Documentation changes should improve implementation speed, preserve consistency across provider guides, and keep examples easy to copy into real projects.
Active docs channel
v1.0
Stable release stream
Version selection is persisted locally so teams can preview upcoming changes without leaving the docs flow.
Principles
- Keep docs implementation-first: explain how to ship the integration before explaining philosophy.
- Use small, copyable code samples with realistic package names and provider constants.
- Maintain the shared provider section order so teams can compare integrations without re-learning the page shape.
- Treat redirect URIs, scopes, issuer domains, and environment variables as first-class deployment details.
Workflow
Choose the target page
Update the relevant guide or add a new canonical page under the docs app routes.
Match the docs voice
Keep copy technical, concise, and implementation-focused rather than marketing-oriented.
Verify the code blocks
Ensure snippets stay small, copyable, and aligned with the shared auth contract.
Quality bar
Structure
Keep page sections predictable so a provider guide reads the same way regardless of the identity system behind it.
Verification
Check links, route names, and copyable snippets whenever the docs information architecture or provider surface changes.
Docs are structured for static generation, searchable navigation, and provider-consistent implementation guides.
Edit this page on GitHub