docs: finish instantiating the RSR docs skeleton - #22
Merged
Conversation
The docs-template skeleton (adopted in #11) was never actually filled in for this repo: docs/architecture.adoc, docs/contributing.adoc, docs/usage.adoc and docs/troubleshooting.adoc still carried unfilled <angle-bracket> placeholders and generic RSR boilerplate describing a built/tested software product (just recipes, an HTTP API, Rust source paths) that does not exist here — this repo is a documentation archive of citable technical notes with no source code, build, or test suite. Root ARCHITECTURE.md/GOVERNANCE.md/MAINTAINERS were similarly unedited scaffold text, and MAINTAINERS/.github/CODEOWNERS/.github/funding.yml still pointed at the template's literal default owner (@metadatastician) instead of this repo's real owner (@hyperpolymath, confirmed via git history and existing SPDX headers). Rewrote all of the above to describe the repo truthfully and minimally (publishing/citation process instead of a fictional software architecture), fixed the stray :revdate: 2026-MM-DD placeholder in the ADR template, dropped a dead link to a nonexistent SECURITY.md, and trimmed mise.toml from a full generic-language toolchain list down to what this repo actually needs (git, typst). No {{...}} placeholders, template-validation scripts, justfile stubs, or .zig sources were found in this checkout, so those cure steps do not apply here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
hyperpolymath
marked this pull request as ready for review
July 27, 2026 18:19
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This repo was minted from the RSR template and got a docs skeleton
(docs/architecture.adoc, docs/contributing.adoc, docs/usage.adoc,
docs/troubleshooting.adoc, ADR 0001) adopted wholesale in #11, but the
skeleton was never actually filled in — it still carried
<angle bracket>placeholder tokens and generic boilerplate describing abuilt/tested software product (
justrecipes, an HTTP API, Rustsource paths) that has never existed in this repo.
technical-notesis, in fact, a documentation archive: short citabletechnical notes, individually deposited on Zenodo with a DOI (see
README.md). No source code, build system, or test suite. This PR
rewrites the process docs to say that, plainly and minimally, instead
of describing a fictional product.
Changes
docs/architecture.adoc,docs/contributing.adoc,docs/usage.adoc,docs/troubleshooting.adoc: replaced unfilled placeholders andfictional software-product content with a truthful description of
the actual publishing/citation process. Fixed the stray
:revdate: 2026-MM-DDplaceholders. Dropped a dead link to anonexistent
SECURITY.md.ARCHITECTURE.md,GOVERNANCE.md,MAINTAINERS(repo root): thesewere 100% unedited generic scaffold text (mentions
src/,tests/,scripts/,config/, "public APIs", multi-maintainer RFC process)that never matched this repo. Rewritten to match reality: single
maintainer, no software architecture.
MAINTAINERS,.github/CODEOWNERS,.github/funding.yml: thesepointed at
@metadatastician, the RSR template's literal defaultowner value, never swapped for this repo's real owner. Corrected to
@hyperpolymath, which matches every commit author and existingSPDX
FileCopyrightTextin this repo.mise.toml: trimmed from a full generic multi-language toolchainlist (node/python/go/java/rust/…) down to what this repo actually
needs —
gitandtypst(for reproducing a note's rendered PDF).Not touched
flake.nix,.tool-versions(not present),.editorconfig,.gitattributes,.gitignore— excluded per estate convention.README.md's CC-BY-4.0 licence line for note content was leftalone: it's consistent with
.zenodo.jsonand is a separate,intentional licence from the MPL-2.0/CC-BY-SA-4.0 covering this repo's
own tooling/process docs.
Not applicable here
No literal
{{...}}mustache placeholders,scripts/validate-template.sh,tests/e2e/template_instantiation_test.sh,justfile, or.zigsources exist in this checkout, so those parts of the standard
instantiation cure don't apply to this repo.
Verification
grep -rn '{{' .(excluding GitHub Actions${{ }}expressions):clean.
grep -rn 'metadatastician': clean.grep -rn 'MM-DD': clean.<...>placeholders in docs: only one intentionalnotational use (
zenodo.<version>describing the DOI format, notan unfilled field).
.github/workflows/*.ymlfiles parse as valid YAML(
python3 -c "import yaml; yaml.safe_load(...)"), each with atleast one job — unchanged by this PR, verified as a regression
check.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com