From 5912f25fefd177c803c1c2279d36da4d8e7bec54 Mon Sep 17 00:00:00 2001 From: forkwright Date: Wed, 19 Aug 2026 17:46:21 -0500 Subject: [PATCH] docs: remove superseded archive copies Git already retains the retired project-standard document. Remove the second archive and its manifest entries so the live documentation tree contains only current authored surfaces. --- docs/MANIFEST.toml | 23 ---------------- docs/archive/README.md | 7 ----- docs/archive/STANDARDS.md | 55 --------------------------------------- 3 files changed, 85 deletions(-) delete mode 100644 docs/archive/README.md delete mode 100644 docs/archive/STANDARDS.md diff --git a/docs/MANIFEST.toml b/docs/MANIFEST.toml index 697feec..b6959ed 100644 --- a/docs/MANIFEST.toml +++ b/docs/MANIFEST.toml @@ -1,12 +1,5 @@ # docs/MANIFEST.toml # Documentation inventory for akroasis. See standards/DOC-MANIFEST.md. -# -# The archive/ subtree IS listed, and the reasoning that first left it out is worth recording because -# it was right in principle and wrong here. Git is the archive, so a second index of superseded -# documents duplicates what history already guarantees. But `STANDARDS/doc-manifest-orphan` asks a -# narrower question — is every file under docs/ accounted for — and an unlisted file is -# indistinguishable from one nobody noticed. Listing them as superseded answers that without -# pretending they are current. [[doc]] path = "docs/ARCHITECTURE.md" @@ -57,19 +50,3 @@ path = "docs/akroasis-mesh.toml" type = "authored" evergreen = false description = "Example mesh configuration section, with the supported hardware and transports." - -# ── superseded ──────────────────────────────────────────────────────────────────────────────────── -# Listed so the orphan check can account for them, marked non-evergreen because that is what -# superseded means. Neither is a current statement about this repository. - -[[doc]] -path = "docs/archive/README.md" -type = "authored" -evergreen = false -description = "Index of completed or superseded documentation kept for historical reference." - -[[doc]] -path = "docs/archive/STANDARDS.md" -type = "authored" -evergreen = false -description = "Superseded project standards, retained as the record of what the rules used to be." diff --git a/docs/archive/README.md b/docs/archive/README.md deleted file mode 100644 index fb320d6..0000000 --- a/docs/archive/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Archive - Akroasis Docs - -Completed or superseded documentation preserved for historical reference. - -| File | Summary | -|------|---------| -| `STANDARDS.md` | Per-project standards file, superseded by `standards/STANDARDS.md` (kanon standards directory). | diff --git a/docs/archive/STANDARDS.md b/docs/archive/STANDARDS.md deleted file mode 100644 index 5ed5ef8..0000000 --- a/docs/archive/STANDARDS.md +++ /dev/null @@ -1,55 +0,0 @@ -# Akroasis Project Standards - -## Error Handling - -- Use [`snafu`](https://docs.rs/snafu) for all error types. -- Define per-module error enums with `#[derive(Debug, Snafu)]`. -- Use context selectors (`SomeContext { field: value }.fail()` or `.context(SomeSnafu)`). -- Never use `.unwrap()` or `.expect()` outside `#[cfg(test)]` modules. -- Error variants that wrap large foreign errors (e.g. `figment::Error`) must box the source to keep enum size reasonable. - -## Commit Conventions - -Format: `category(scope): what` - -| Category | Use for | -|----------|---------| -| `feat` | New capability | -| `fix` | Bug fix | -| `docs` | Documentation only | -| `refactor` | No behaviour change | -| `test` | Test additions/fixes | -| `chore` | Build, deps, config | -| `style` | Formatting, lint | - -Scope is optional but encouraged for workspace members (e.g. `feat(koinon): ...`). - -## Lint Rules - -Enforced at workspace level in `Cargo.toml`: - -```toml -[workspace.lints.rust] -unsafe_code = "forbid" -missing_docs = "warn" - -[workspace.lints.clippy] -unwrap_used = "deny" -expect_used = "deny" -panic = "deny" -indexing_slicing = "warn" -pedantic = { level = "warn", priority = -1 } -nursery = { level = "warn", priority = -1 } -``` - -CI runs `cargo clippy --workspace --all-targets -- -D warnings`, so all warn-level lints become errors in CI. - -Add `#[allow(clippy::expect_used, clippy::unwrap_used)]` to `#[cfg(test)]` modules where panicking assertions are appropriate. - -## Testing - -- Unit tests live in the same file, inside `#[cfg(test)] mod tests { ... }`. -- Integration tests live under `tests/` in the crate root. -- Test names describe what is being verified: `fn valid_coordinates_accepted()`. -- Use `assert!`, `assert_eq!`, `assert_ne!` - do not write custom assertion logic unless necessary. -- Doc-tests (`cargo test --workspace --doc`) must also pass.