From 9fa77dcd721b9b3d6c70e93749fffb97700b4a94 Mon Sep 17 00:00:00 2001 From: l-nmch Date: Wed, 28 Oct 2026 23:10:50 +0100 Subject: [PATCH] docs: no wiki, and who docs/ is for Part of #27 --- SUPPORT.md | 2 +- docs/reference/documentation-standard.md | 6 ++++++ labels.json | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/SUPPORT.md b/SUPPORT.md index 5833696..45a49fe 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,6 +1,6 @@ # Getting help -- **Using or contributing**: read the repository README and its wiki, then open an issue with the `question` template. +- **Using or contributing**: read the repository README and its `docs/` folder, then open an issue with the `question` template. - **Bugs and ideas**: open an issue with the matching template in the right repository ([map of repositories](AGENTS.md#repositories)). - **Security problems**: never in public, see [SECURITY.md](SECURITY.md). - **Anything else**: `contact@phorge.fr`. diff --git a/docs/reference/documentation-standard.md b/docs/reference/documentation-standard.md index 2afcedc..67e130a 100644 --- a/docs/reference/documentation-standard.md +++ b/docs/reference/documentation-standard.md @@ -61,6 +61,12 @@ The title is the single `#` heading, written in sentence case. Decision records use the MADR header instead: `status`, `date`, `decision-makers` (and optionally `consulted`, `informed`). The filename is `NNNN-short-title.md`. Start from [the template](../../templates/docs/decision.md). A decision is never rewritten: a new record supersedes it and the old one is marked `superseded by ...`. +## Who the documentation is for + +`docs/` in a repository is for the people who build and operate Phorge: contributors and operators. It is the single source: GitHub renders it, a pull request reviews it, `docs-lint` checks it. There is no wiki, because a wiki cannot be reviewed or checked, has no folders and would be a second copy. + +Documentation for the users of the cloud (getting started, the API guide, the Terraform provider) is a different audience. It lives in its own repository when Phorge is public, with the generated parts (the OpenAPI document, the provider reference) pulled from the code, and is never mixed into a repository's `docs/`. + ## Rules against empty documentation 1. A page has a reader and a purpose, written in its header. No reader, no page. diff --git a/labels.json b/labels.json index 03e719e..534a8dd 100644 --- a/labels.json +++ b/labels.json @@ -57,7 +57,7 @@ { "name": "area/docs", "color": "0075ca", - "description": "Documentation, wiki, READMEs" + "description": "Documentation and READMEs" }, { "name": "area/ci",