.. _content_writing:

Content writing
===============

This section is for technical writers and contributors who write, edit, and review
user-facing documentation for PyAnsys libraries.

If your main goal is documentation infrastructure, deployment, or project-level
maintenance workflows, start with :ref:`documenting_developers`.

.. grid:: 2

    .. grid-item-card:: :octicon:`tools` Content contribution setup
      :link: content-contrib-setup/index
      :link-type: doc
      :padding: 2 2 2 2

      Set up your content development environment and core contributor resources.

    .. grid-item-card:: :octicon:`file-code` Content in RST files
      :link: rst-files-writers/index
      :link-type: doc
      :padding: 2 2 2 2

      Write and format narrative documentation pages in RST.

    .. grid-item-card:: :octicon:`code` Content in PY files
      :link: py-files-writers/index
      :link-type: doc
      :padding: 2 2 2 2

      Write docstrings and code-adjacent content in Python files.

    .. grid-item-card:: :octicon:`beaker` Content in examples
      :link: examples-writers/index
      :link-type: doc
      :padding: 2 2 2 2

      Build examples with Sphinx-Gallery or nbsphinx workflows.

    .. grid-item-card:: :octicon:`tasklist` Content how-tos
      :link: content-how-tos/index
      :link-type: doc
      :padding: 2 2 2 2

      Complete contribution tasks such as PRs, checks, and review work.


.. toctree::
   :maxdepth: 3
   :hidden:

   content-contrib-setup/index
   rst-files-writers/index
   py-files-writers/index
   examples-writers/index
   content-how-tos/index