.. _Documentor's Home:

Open edX Documentors
####################

.. grid:: 1 2 2 2
   :gutter: 3
   :padding: 0

   .. grid-item-card:: Quick Starts
      :class-card: sd-shadow-md sd-p-2
      :class-footer: sd-border-0
      :columns: 12

      .. toctree::
         :maxdepth: 1

         quickstarts/first_documentation_pr.rst
         quickstarts/quick_start_add_doc.rst
         quickstarts/update_doc_via_github.rst

   .. grid-item-card:: Understand the Open edX® Documentation
      :class-card: sd-shadow-md sd-p-2
      :class-footer: sd-border-0

      .. image:: /_images/documentors_homepage/understand_docs_undraw.png
         :alt: Documentors
         :height: 150px
         :align: center

      .. toctree::
         :maxdepth: 1

         concepts/about_open_edx_documentation_standards.rst
         references/doc_guidelines.rst
         references/doc_maintenance.rst
         references/doc_style_guide.rst
         references/doc_templates.rst
         references/quick_reference.rst
         references/markdown_syntax_sample.md
         concepts/about_doc_audiences.rst

   .. grid-item-card:: Report an Issue with the Documentation
      :class-card: sd-shadow-md sd-p-2
      :class-footer: sd-border-0

      .. image:: /_images/documentors_homepage/raise_issue_undraw.png
         :alt: Documentors
         :height: 150px
         :align: center

      .. toctree::
         :maxdepth: 1

         how-tos/report_problem_with_docs.rst

   .. grid-item-card:: Edit an Existing Document
      :class-card: sd-shadow-md sd-p-2
      :class-footer: sd-border-0

      .. image:: /_images/documentors_homepage/edit_doc_undraw.png
         :alt: Documentors
         :height: 150px
         :align: center

      .. toctree::
         :maxdepth: 1

         how-tos/update_a_doc_via_github.rst
         how-tos/make_changes_to_your_pull_request.rst
         references/doc_english_writing.rst
         references/doc_style_guide.rst
         references/doc_templates.rst
         references/quick_reference.rst
         how-tos/develop_docs_locally.rst

   .. grid-item-card:: Add a New Document
      :class-card: sd-shadow-md sd-p-2
      :class-footer: sd-border-0

      .. image:: /_images/documentors_homepage/add_doc_undraw.png
         :alt: Documentors
         :height: 150px
         :align: center

      .. toctree::
         :maxdepth: 1

         how-tos/add_a_doc_via_github.rst
         references/doc_checklist.rst
         how-tos/make_changes_to_your_pull_request.rst
         references/doc_english_writing.rst
         references/doc_style_guide.rst
         references/doc_templates.rst
         references/quick_reference.rst


      .. toctree::
         :maxdepth: 1
         :hidden:

         decisions/index

   .. grid-item-card:: Decisions
      :class-card: sd-shadow-md sd-p-2
      :class-footer: sd-border-0
      :columns: 12

      A record of all documentation related decisions we've made.
      +++
      .. button-ref:: decisions/index
         :color: primary
         :outline:
         :expand:

         All Decisions