jpmschweitzer/odysseus
1
0
Fork 0
mirror of https://github.com/pewdiepie-archdaemon/odysseus.git synced 2026-10-20 13:52:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(maintainers): list website/ in the docs map and align CONTRIBUTING

Browse Source 
Setup, configuration and deployment docs live in website/, which is
published as the docs site, but the map sent them to /docs and did not
list website/ at all. Add it, and drop the "when those paths are used"
hedge on /specs, which exists.

CODEOWNERS has no rules until #593 settles the per-area map; say so
instead of describing reviewers it does not list.

CONTRIBUTING.md still had a single maintainer curating main, which the
Release Maintainer section replaces. Name the Product Owner's GitHub
account and say where a community proposal starts, matching the
existing issue forms.
This commit is contained in:
Léo
2026-10-15 18:09:36 +02:00
parent b97c1ee50f
commit 55b5b7f496
4 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+1 -1
View File
@@ -7,7 +7,7 @@ Thanks for helping. The project is moving quickly, so the best contributions are
Odysseus has two branches:
- **`dev`** — where all PRs land. Things can be in flux here; the merge button gets used freely.
- **`main`** — what users run. Curated and tested by the maintainer. Fast-forwarded to a stable `dev` commit at each release.
- **`main`** — what users run. Curated and tested by the release's [Release Maintainer](docs/maintainers/testing-and-releases.md#release-ownership). Fast-forwarded to a stable `dev` commit at each release.
**Open your PR against `dev`, not `main`.** The GitHub "base" dropdown defaults to `dev`. If you opened a PR against `main` by accident, click "Edit" on the PR and change the base — no rebase needed.
docs/maintainers/changes-and-review.md
+1 -1
View File
@@ -43,7 +43,7 @@ A high-risk review should verify the threat or failure model, exact final commit
## Cross-area changes and CODEOWNERS
Touching multiple areas does **not** automatically require multiple approvals. Consult domain expertise when needed. CODEOWNERS helps identify reviewers and accountable contacts; it is not a blanket approval requirement by itself. See [issue #593](https://github.com/odysseus-dev/odysseus/issues/593) for the ongoing ownership map discussion.
Touching multiple areas does **not** automatically require multiple approvals. Consult domain expertise when needed. `.github/CODEOWNERS` currently contains no ownership rules; the per-area map is under discussion in [issue #593](https://github.com/odysseus-dev/odysseus/issues/593). Once populated, it helps identify reviewers and accountable contacts; it is not a blanket approval requirement by itself.
## Validation and UI evidence
docs/maintainers/documentation.md
+4 -2
View File
@@ -7,8 +7,9 @@ Repository Markdown is the canonical source for project documentation. A public
| Location | Purpose |
|---|---|
| `/design` | Product intent, proposals, and accepted decisions (when those paths are used) |
| `/specs` | Technical contracts and invariants (when those paths are used) |
| `/docs` | User, developer, architecture, security, deployment, and maintainer guidance |
| `/specs` | Technical contracts and invariants |
| `/website` | User, setup, configuration, and deployment guidance (published as the docs site) |
| `/docs` | Developer, architecture, security, and maintainer guidance |
| Root Markdown | Discoverable entry points and policies |
Keep root documents easy to find:
@@ -16,6 +17,7 @@ Keep root documents easy to find:
- `README.md`
- `CONTRIBUTING.md`
- `SECURITY.md`
- `THREAT_MODEL.md`
Not every named directory exists today; do not invent a parallel documentation store just to match this map.
docs/maintainers/product-and-features.md
+3 -1
View File
@@ -1,6 +1,6 @@
# Product and feature proposals
Pewds is the Product Owner for Odysseus and has final authority over product direction. Maintainers own technical feasibility, implementation, and safety.
Pewds ([@pewdiepie-archdaemon](https://github.com/pewdiepie-archdaemon)) is the Product Owner for Odysseus and has final authority over product direction. Maintainers own technical feasibility, implementation, and safety.
## Which changes require product approval?
@@ -27,6 +27,8 @@ A Product Owner proposal is already product-approved; it is not automatically te
## Community or maintainer initiated
Community proposals start as a Feature Request issue. Check [ROADMAP.md](../../ROADMAP.md) and existing issues first; take early ideas to [Discussions](https://github.com/odysseus-dev/odysseus/discussions/categories/ideas).
```text
Feature proposal
-> Product Owner accepts / rejects, where approval is required