Getting Started#

If you have developed a new feature, created an XBlock, or otherwise see that a topic is missing in this documentation, you can create one or more new pages in this document and submit a pull request to have the content added. Follow the guidelines below.

When you are ready to update documentation, see Quick Start: Add New Documentation Through GitHub.

GitHub#

Open edX documentation, along with source code, is managed in GitHub, in the Open edX Documentation GitHub repository.

Anyone can propose updates to the documentation, following a process known as the GitHub Flow.

The Open edX team will review the proposed changes, collaborate with the author, and merge the documentation when it is ready. You will then see it on the Open edX Documentation site.

RST#

Open edX documentaiton is written in RST. If you are not familiar with RST, we recommend going through Quick Reference: Writing RST.

We also provide Documentation Templates you can copy from as you create a new documentation.

We also recommend reviewing the RST Primer if you have questions.

Get Started#

When you have identified the audience(s) and content type(s) you need to address, we recommend that you follow the steps in Quick Start: Add New Documentation Through GitHub.

If you have questions as you go, we recoomend asking the Open edX Documentation Slack channel.
https://docs.openedx.org/en/latest/documentors/references/doc_guidelines.html
docs.openedx.org
CC-MAIN-2023-23
60362
application/http; msgtype=response
sha1:SFFEDN4GOBN4JFRVNLBSLPH6XALWOCND
<urn:uuid:b0475d60-2346-41e9-a4c1-09b040615ea6>
2023-05-30T17:02:36Z
104.17.33.82
text/html
sha1:6SUHQ3XLNWBMZ6FSLMELZE5IF7JKJA6Q
<urn:uuid:0c711be9-e812-4dad-b279-4df0e4aacaf3>
https://docs.openedx.org/en/latest/documentors/references/doc_guidelines.html
response
<urn:uuid:7839bde4-76f4-41b4-a280-df8de3b3b4a6>
isPartOf: CC-MAIN-2023-23
publisher: Common Crawl
description: Wide crawl of the web for May/June 2023
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-188
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.4-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/