Sitemap¶
BASICS
- About This Guide
- Help & Support
- Basic Principles
- Conventions, CGL, Best Practices
- Spelling
- Directories and File Names
- Formats (reST, Markdown)
- Menu Hierarchy
- Coding Guidelines for reST Files
- Guidelines for Creating Images
- Commit Messages
- Update Documentation for New Releases
- Licenses
- reStructuredText & Sphinx
- Introduction
- Basic reST & Sphinx Syntax
- Common Pitfalls
- reST & Sphinx Cheat Sheet
- reST & Sphinx Reference
- Bold, Italic etc.
- Hyperlinks & Cross-referencing
- Codeblocks with Syntax Highlighting
- Inline Code & Textroles
- Headlines and Sections
- Toctree and the Hierarchical Structure of a Manual
- Including Files
- Bullet Lists
- Numbered Lists
- Definition Lists
- List Items as Buttons
- How Does It Work?
- Available Styles
- horizbuttons-attention-m
- horizbuttons-important-m
- horizbuttons-note-m
- horizbuttons-primary-m
- horizbuttons-striking-m
- horizbuttons-tip-m
- horizbuttons-warning-m
- horizbuttons-attention-xxl
- horizbuttons-important-xxl
- horizbuttons-note-xxl
- horizbuttons-primary-xxl
- horizbuttons-striking-xxl
- horizbuttons-tip-xxl
- horizbuttons-warning-xxl
- horizbuttons-attention-xxxl
- horizbuttons-important-xxxl
- horizbuttons-note-xxxl
- horizbuttons-primary-xxxl
- horizbuttons-striking-xxxl
- horizbuttons-tip-xxxl
- horizbuttons-warning-xxxl
- Styled Numbered Sections (big-nums)
- Images
- Embed YouTube Videos
- Tip, Note, Important etc. (Admonitions)
- Comments
- Tables
- Special Characters
- Orphaned Pages
- Clever reST
- Special Styles
HOWTOS
- How to Write Good Content
- Tips for Writing Good Content
- How People Read on the Web
- Tip 1: Write for Online Reading
- Tip 2: Use paragraphs
- Tip 3: Use Subheaders
- Tip 4: Read your own content!
- Tip 5: Use a Consistent and Clear Vocabulary
- Tip 6: Write simple, short sentences
- Tip 7: Use a spellchecker
- Tip 8: Use StackOverflow to Learn
- Tip 9: Read other documentation
- Tip 10: Read Your Own Content
- Additional Resources
- Writing a Tutorial
- Tips for Writing Good Content
- How to Document an Extension
- Start Extension Documentation From Example Manual
- Start Documentation With Extension Builder
- Migrate Documentation
- Webhook
- FAQ
- Why Does the Documentation not Provide a Title?
- How Do I Find My New Rendered Documentation?
- Is it Possible to Highjack Extension Documentation?
- Is There a Way to Manually Trigger Docs Rendering Aside From a Git Repository Push?
- Is Documentation Independant of TER?
- Should I Add a Link to the Documentation in TER?
- Can I use a README.rst (or README.md) instead?
- How do I Get an “Edit me on GitHub” Button
- How can I link to my Issues?
- Further Questions?
- Contribute to System Extension
- Contribute to Third Party Extension
- How to Contribute to Official Documentation
- Workflow #1: “Edit me on Github”
- Workflow #2: “Local Editing and Rendering with Docker”
- How You Can Help
- Make Minor Changes
- Fix Issues
- Review Pull Requests
- Write New Content
- Add Diagrams
- Create Cheat Sheets
- Replace Outdated Images
- Add YouTube Videos
- Review Manuals
- Teach
- Motivate
- Spread the Word
- Blog About Your Contributions
- Make Suggestions for New Content
- Add Information from the ChangeLog
- Check Spelling
- More Ideas?
- Tools for Editing reST
- How to Render Documentation
- How to Work With GitHub
- How to Add Translation
ADVANCED
OTHER