Skip to content

Commit

Permalink
Add a WIP section, so the doc build doesn't have to fail for new desi…
Browse files Browse the repository at this point in the history
…gn docs.

It is not possible to build without error in the presence of a document that
is not in the index. In order for CS not to fail for PRs that include a new,
not-yet-approved doc, adding an index section where they can be safely linked.
  • Loading branch information
jiceatscion committed Jul 22, 2024
1 parent d9c3e2d commit 4b22bd0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion doc/dev/design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ See section :ref:`change-proposal-process` for the overview on the overall
contribution process.

- **Creation**:
Design documents are created from the template :file-ref:`doc/dev/design/TEMPLATE.rst`.
Design documents are created from the template :file-ref:`doc/dev/design/TEMPLATE.rst`. While the design is still being discussed, it is linked in the WIP
section :ref:`design-docs-wip`

Once discussion on a change proposal converges and a design document is
approved, it is inserted to section :ref:`design-docs-active`.
Expand All @@ -30,6 +31,13 @@ contribution process.
a useful reference for the current system, it moves to section :ref:`design-docs-outdated`.


.. _design-docs-wip:

WIP
===
.. toctree::
:maxdepth: 1

.. _design-docs-active:

Active
Expand Down

0 comments on commit 4b22bd0

Please sign in to comment.