Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/documentation-standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion labels.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
{
"name": "area/docs",
"color": "0075ca",
"description": "Documentation, wiki, READMEs"
"description": "Documentation and READMEs"
},
{
"name": "area/ci",
Expand Down
Loading