Documentation Contributor

Write docs, set up Sphinx, and follow documentation standards. Find everything you need to contribute to SKAO documentation.

Get Started#

New to writing SKAO documentation? Start here.

Set up your environment and start contributing to SKAO projects

Understand contribution guidelines, branching policy, and merge requests

Follow these standards to write clear, consistent documentation.

Active voice, formatting, accessibility, and Diataxis framework guidelines

Community standards and expectations for all contributors

Language-specific standards including docstring conventions

Set up and use SKAO’s documentation toolchain.

Set up Sphinx, structure your docs folder, and integrate with ReadTheDocs

Add or update content on the Developer Portal

Use these tools and processes when contributing documentation.

Beginner's guide to documentation

Official Sphinx user guide

RST syntax reference

Tip

Questions about documentation?

Ask in #team-system-support on Slack or check the SKA Python Skeleton for working examples.