From 2a1eeeab2ba20c46f31f7cd84ab6f33c12bba0cb Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 18:40:00 -0300 Subject: [PATCH 1/4] docs: add repository guidance Signed-off-by: Vitor Mattos --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..061aaa0 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ + + +# LibreSign documentation + +Source repository for the public LibreSign documentation published at https://docs.libresign.coop. + +The repository contains user, administrator and developer documentation built with Sphinx. Product source code and canonical release changelogs live in `LibreSign/libresign`; this repository documents how LibreSign is used, operated and maintained. + +## Start here + +- Main documentation: `main/` +- User manual: `user_manual/` +- Administrator manual: `admin_manual/` +- Developer manual: `developer_manual/` +- Local documentation dependencies: `requirements.txt` + +Use the repository's documentation workflow to validate changes before merging. From bb166e9fbb271598121485152bb6a736c1545662 Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 18:40:02 -0300 Subject: [PATCH 2/4] docs: add repository guidance Signed-off-by: Vitor Mattos --- AGENTS.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..328fd4b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,39 @@ + + +# Agent guidance + +## Purpose + +This repository owns public human documentation for LibreSign. + +## Boundaries + +- LibreSign application code lives in `LibreSign/libresign`. +- Canonical release history/changelog data lives only in `LibreSign/libresign/docs/changelogs/changelog-.md`; do not duplicate it here. +- Document public behavior, operator procedures, architecture intended for maintainers and recovery/troubleshooting. +- Do not copy implementation details that are better maintained next to the source code. +- Generated Sphinx output must not be committed unless the repository explicitly tracks that output. + +## Documentation structure + +Keep changes in the appropriate manual: + +- `user_manual/`; +- `admin_manual/`; +- `developer_manual/`; +- `main/` for top-level navigation. + +## Quality gates + +Build the affected Sphinx manuals. Pull requests should pass the Documentation workflow; developer documentation is built with warnings treated as errors. + +## Licensing + +Preserve the documentation-specific Creative Commons licensing and existing SPDX conventions. Do not silently relicense documentation under the application/code license. + +## Safety + +Do not publish secrets, private security-advisory content or personal data in examples, screenshots or release documentation. From 992d03b899cd3bdefaf67079c438941b29f8e22b Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 18:40:20 -0300 Subject: [PATCH 3/4] docs: preserve documentation license Signed-off-by: Vitor Mattos --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 061aaa0..a6ffaa4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # LibreSign documentation From acde3ebd355ed8aefb83241750818c8411ec6909 Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 18:40:23 -0300 Subject: [PATCH 4/4] docs: preserve documentation license Signed-off-by: Vitor Mattos --- AGENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 328fd4b..98b0ec3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # Agent guidance