Locate Documentation
Files are usually in the <username>/edx-documentation/en_us/<guide>/source/ folder.
Guide Name | Source Files |
---|---|
Building and Running an edX Course | edx-documentation/en-us/course_authors |
Building and Running an Open edX Course | edx-documentation/en-us/open_edx_course_authors |
EdX Learner's Guide | edx-documentation/en-us/students |
Open edX Learner's Guide | edx-documentation/en-us/open_edx_students |
Installing, Configuring, and Running the Open edX Platform | edx-documentation/en-us/install_operations |
EdX Research Guide | edx-documentation/en-us/data |
EdX Developer's Guide | edx-documentation/en-us/developers |
Insights Guide | edx-analytics-dashboard repo |
API docs | edx-platform/docs, edx-platform/djangoapps, other locations |
IDA documentation | multiple - these documents live “with the code" |
XBlock Tutorial | edx-documentation/en-us/xblock-tutorial |
OLX Guide | edx-documentation/en-us/olx |
Edit Documentation
Edit documentation .rst files in Sublime. Use markup to format the text. An example .rst file with the most common formatting in the docs is available online in the EdX Style Guide or locally at edx-documentation/en-us/edx_style_guide/source/ExampleRSTFile.rst (after you clone the edx-documentation repo).
- In Sublime, open the file that you want to change. You can also open Finder and navigate to the file.
- Edit and save the files that you want to update.
For more information about Sublime, see Documentation Tools.
Optional: Add Image Files (Finder)
You can use Preview or Grab (pre-installed on Macs), Snag-It, or another application to take screen shots, and then use Snag-It or Adobe Photoshop to manipulate them. The edX Style Guide contains instructions for adding images to a topic as well as image conventions, including size and call-out colors.