Contributing to Documentation¶
Thank you for your interest in improving Glassy's documentation.
How You Can Help¶
Report Issues¶
Found outdated information or a missing article? Report it through: - GitHub Issues - In-app feedback ("Was this helpful?")
Contribute Content¶
- Follow the voice and tone guidelines below
- Fork the
0Reliance/glassy-docsrepository - Make your changes
- Submit a pull request to
0Reliance/glassy-docs
Content Guidelines¶
Voice and Tone¶
- Write in second person ("you")
- Be empathetic, never patronizing
- Use clear, plain language
- Avoid jargon without explanation
Structure¶
- One main idea per paragraph
- Use headings to organize content
- Include practical examples
- Add related article links
Formatting¶
- Use code blocks for technical content
- Use tables for comparisons
- Use callouts for important notes
- Keep lists under 7 items
Recognition¶
Contributors are recognized in the changelog and release notes.
Questions?¶
Contact the documentation team through the Help Center.