Skip to content
audstav edited this page Jan 1, 2020 · 13 revisions

Thank you for your interest in contributing to Oppia's documentation.

Even if you're completely new to open source, you will find all the information you need here to guide you towards setting up and contributing to the documentation.

How is the documentation written?

Oppia uses Read the Docs as the hosting platform. Read the Docs hosts documentation generated by Sphinx and written in a markup language called reStructuredText (reST).

Sphinx takes a bunch of text files written in reST (.rst files) and renders it as HTML.
reST -> Sphinx -> HTML

The files are then pushed to the creator-documentation repository. As Oppia's Read the Docs account is connected or 'hooked' to the repository, the docs are automatically integrated into the platform.

Steps involved in contributing

The way for new contributors to propose changes to the documentation is to fork the repository on GitHub and then submit a pull request after making the changes to the .rst files in the repository. When the pull request is merged, it will trigger a rebuild of the online documentation. The following covers all the steps you need to do to get up and running.

  1. Forking and cloning the creator-documentation repository
  2. Editing the documentation (.rst files)
  3. Running a local build in HTML
  4. Submitting a pull request

Clone this wiki locally