Contributing guide

This is the contributor guide for the govuk-tech-docs-sphinx-theme project.

• Code of conduct for govuk-tech-docs-sphinx-theme
  • Civil Service Code
  • Contributor Covenant Code of Conduct
• Contributing
  • Code of Conduct
  • Getting started
  • Code conventions
  • Testing
  • Documentation
• Development of the govuk-tech-docs-sphinx-theme
  • Comparing with GOV.UK Tech Docs template
  • Fixing missing attributes and classes with jQuery
  • Fixing missing styles with CSS
  • GOV.UK Design System components
• Pre-commit hooks
  • Purpose
  • Installation
  • Using the detect-secrets pre-commit hook
• Loading environment variables
  • Using direnv
  • Storing secrets and credentials
• Updating the .gitignore file
• Writing Sphinx documentation
  • Why should I bother? And why Sphinx?
  • Writing in reStructuredText
  • Writing in ReST-enabled Markdown