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
39 changes: 39 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!--
SPDX-FileCopyrightText: 2026 LibreCode coop and contributors
SPDX-License-Identifier: CC-BY-3.0
-->

# 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-<major>.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.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!--
SPDX-FileCopyrightText: 2026 LibreCode coop and contributors
SPDX-License-Identifier: CC-BY-3.0
-->

# 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.
Loading