Sitemap¶
BASICS
- About this guide
- Help & Support
- Basic principles
- Documentation content style guide
- Spelling
- Spelling, terms and glossary
- Directories and file names
- Examples
- Formats (reST, Markdown)
- Menu hierarchy
- Coding guidelines for reST files
- Guidelines for creating images
- Commit messages
- Licenses
- reStructuredText & Sphinx
- Introduction
- Basic reST & Sphinx syntax
- Common pitfalls
- reST & Sphinx cheat sheet
- reST & Sphinx reference
- Bold, Italic etc.
- Hyperlinks & cross referencing
- Code blocks with syntax highlighting
- Inline code & text roles
- 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 (bignums)
- Images
- Embed YouTube videos
- Tip, Note, Important etc. (Admonitions)
- Comments
- Tables
- Special characters
- PlantUML diagrams
- 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: Think about your audience
- Tip 5: Use a consistent and clear vocabulary
- Tip 6: Write simple, short sentences
- Tip 7: Use a spellchecker
- Tip 8: Use Stack Overflow to learn
- Tip 9: Read other documentation
- Tip 10: Read your own content
- Additional Resources
- Writing a tutorial
- Writing Resources
- Tips for writing good content
- How to document an extension
- Start extension documentation from the example manual
- Start documentation with the extension builder
- Register for docs.typo3.org
- Webhook
- Reregister versions
- FAQ
- I am missing some documentation for extension versions
- 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 documentation rendering aside from a Git repository push?
- Is the documentation independent of the 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 on GitHub” button?
- How can I link to my issues?
- Further Questions?
- Contribute to system extensions
- Contribute to third-party extensions
- Contribute to the TYPO3 documentation
- Workflow #1: “Edit 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
- Review documentation
- 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
ADVANCED
MAINTAINERS