Contributing to ODK Docs

• Docs Contributor Technical Guide
  • Before you begin
  • Initial Setup
  • Working on the docs
  • The next time you work
  • Keep improving
• Docs Markup and Syntax Guide
  • Indentation
  • Documentation Files
  • Tables of Content
  • Sections and Titles
  • Basic Markup
  • Sphinx-specific Markup
• Docs Style Guide
  • Spelling and grammar
  • Writing code and writing about code
  • ODK jargon
• Docs Developer Guide
  • Tech Overview
  • Custom HTML templating
  • Custom JavaScript
  • Custom CSS
  • Style Guide checks
• Tips for Making Good Contributions
  • Smallest meaningful PR
  • Descriptive PR names
  • Small, atomic commits
  • Discuss issues before working
  • Claim issues
  • Share work in progress
  • If you get stuck while working
  • If an issue takes a long time to complete
  • Issues only
  • Actually install and use ODK or other tools
  • Always build locally
  • You are not an impostor
• Working with Docs in Windows using Cygwin
  • The prerequisites
  • The requirements
  • Install the Requirements