Skip to content

Commit aa7a8b6

Browse files
committed
docs: move regen instructions to DEVELOPMENT.md, fix orphaned contrast sentence
The "regenerate this table via make docs" note is a maintainer instruction, not something a node operator needs to see, and referenced a Makefile target that no longer exists (it's cli-docs). Dropped it from the two operator-facing options pages and folded the instruction into DEVELOPMENT.md's existing regeneration section instead. Also fixed a sentence in the legacy did:nuts client-authentication section that only made sense next to the did:x509 section it used to sit beside in certificates.rst before this PR split them into separate pages ("Nuts- node versions before v6 only use..." read as an orphaned historical claim once the did:x509 contrast it was set up against moved elsewhere). Assisted by AI Claude-Session: https://claude.ai/code/session_01VJiY69SPaAf1mxERAWK1SG
1 parent 8226952 commit aa7a8b6

4 files changed

Lines changed: 5 additions & 24 deletions

File tree

DEVELOPMENT.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ All files to be included can be generated using:
6363
make cli-docs
6464
```
6565

66-
This regenerates the config-option and CLI reference tables from code.
66+
This regenerates the config-option and CLI reference tables from code, and the root `README.rst` from `README_template.rst`.
67+
Whenever you add, remove, or change a config flag or CLI command, run this and commit the regenerated files —
68+
don't hand-edit `docs/pages/configuration/server_options*.rst` or `docs/pages/operations/cli-reference.rst`.
6769

6870
If needed, you can also build the documentation locally in `/docs/_build` using Docker; see [docs/README.md](docs/README.md).
6971

README.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -307,13 +307,6 @@ The following options can be configured on the server:
307307
-
308308
- Base URL of the AuthZen PDP endpoint. Required when any credential profile uses scope_policy 'dynamic'; the node refuses to start if such a profile is configured but this flag is empty.
309309

310-
This table is automatically generated using the configuration flags in the core and engines. When they're changed
311-
the options table must be regenerated using the Makefile:
312-
313-
.. code-block:: shell
314-
315-
$ make docs
316-
317310
If your use case still uses ``did:nuts`` DIDs and/or the gRPC network, there's an additional (deprecated) options
318311
table in :ref:`Legacy did:nuts configuration <legacy-did-nuts-configuration>`.
319312

docs/pages/configuration/legacy-did-nuts.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,11 @@ The following table contains additional (deprecated) options that are relevant f
1313

1414
.. include:: server_options_didnuts.rst
1515

16-
This table is automatically generated using the configuration flags in the core and engines. When they're changed
17-
the options table must be regenerated using the Makefile:
18-
19-
.. code-block:: shell
20-
21-
$ make docs
22-
2316
Client authentication
2417
**********************
2518

26-
Nuts-node versions before v6 only use TLS certificates for client authentication on the ``/n2n`` endpoints and in the ``gRPC Nuts network``.
27-
The Nuts-node also validates the client certificates used by its peers on the ``gRPC network`` when a new connection is established, and periodically after that as long as the connection exists.
19+
The ``/n2n`` endpoints and the ``gRPC Nuts network`` use TLS certificates for client authentication.
20+
The Nuts-node validates the client certificates used by its peers on the ``gRPC network`` when a new connection is established, and periodically after that as long as the connection exists.
2821
To do this, all trusted certificate chains must be configured in ``tls.truststorefile``.
2922
See :ref:`Certificate revocation handling <certificate-revocation-handling>` for how CRL checks and soft-fail behavior work for these certificates.
3023
The ``gRPC Nuts network`` and ``/n2n`` endpoints are deprecated and will be removed in the future.

docs/pages/configuration/options.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,6 @@ The following options can be configured on the server:
5050
5151
.. include:: server_options.rst
5252

53-
This table is automatically generated using the configuration flags in the core and engines. When they're changed
54-
the options table must be regenerated using the Makefile:
55-
56-
.. code-block:: shell
57-
58-
$ make docs
59-
6053
If your use case still uses ``did:nuts`` DIDs and/or the gRPC network, there's an additional (deprecated) options
6154
table in :ref:`Legacy did:nuts configuration <legacy-did-nuts-configuration>`.
6255

0 commit comments

Comments
 (0)