Repository navigation
#137: Keep the design decisions in docs/_archive/ and an overview of open debt in docs/_backlog/ - #138
Merged
miroslavpojer merged 1 commit intoNov 12, 2026
Conversation
…open debt in docs/_backlog/ - docs/_archive/decisions.md: 107 decisions behind the current design and planned work, each with its reason and the page that holds its rule - docs/_backlog/debt-overview.md: one row per open tech-debt or epic issue of the seven repositories (55), with link, topics, anchors and wake tag - tests/docs/debt_overview_check.py and debt-overview.yml: drift check on a PR, by hand and weekly; drift found by the weekly run opens or updates one Documentation Task issue - CONTRIBUTING.md: both folders at level D; the debt overview exempt from the no-anchor rule - AGENTS.md, the CONTEXT.md files and tests/README.md point agents at the overview and describe the check
miroslavpojer
deleted the
docs/137-decision-archive-and-debt-overview
branch
November 12, 2026 21:34
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 free
to 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.
Overview
This PR adds two maintainer pages and a check that keeps the second one true.
docs/_archive/decisions.md):## Purposesays what the page is: append-only and not canon.## Contentsfollows, then one table| No. | Date | Decision | Why | Rule lives in |.master, or the epic or issue a planned-work decision binds.docs/_archive/and an overview of open debt indocs/_backlog/#137).docs/_backlog/debt-overview.md):living-doc27,living-doc-utilities13,living-doc-toolkit7,living-doc-collector-gh5,living-doc-generator-markdown3.tests/docs/debt_overview_check.py):type:tech-debt,type:epic,tech debtorepic. It uses the REST API, paginated, withGITHUB_TOKENorGH_TOKENwhen set.tests/docs/test_debt_overview_check.py) run offline: one test per finding kind, a clean case, pagination, malformed GitHub answers, and a parse of the real page..github/workflows/debt-overview.yml):checkjob hascontents: readonly.reportjob runs only on a scheduled run that finds drift, and it alone hasissues: write. It opens the onetype:documentationissue titled "Bring the debt overview in line with the open issues", or comments on it if it is already open.AGENTS.md§ This project, in a new § Open debt, andCONTEXT.md§ Conventions say: before changing code in any of the seven repositories, search the overview. On a hit, say in the PR whether the change fixes the debt, makes it worse or leaves it. The § Commands Check now runs the drift check.PAGESintests/docs/pages.py.CONTRIBUTING.md§ Writing documentation puts both folders at level D.CONTRIBUTING.mdlinks both pages, so each is two links fromREADME.md.docs/CONTEXT.md§ Layout states both folders' rules.A disagreement with the canon was raised on #137 before it was coded. The issue lists
module.py::symbolas an anchor form, which flow rule 6 forbids on every page. The owner decided to exempt the debt overview: rule 6's text names it, andANCHOR_PAGESintests/docs/pages.pyleaves it out of the no-anchor test.Acceptance criteria:
test_the_page_parses_and_uses_only_listed_tagsand the live check show it.AGENTS.md§ Open debt,CONTEXT.md§ Conventions anddocs/CONTEXT.md§ Layout.AGENTS.md§ Check:pytest tests/examples tests/docs tests/integration: 382 passed.examples_check.py: OK atliving-doc-utilities0.8.1.retired_names_check.py --strictover the pinned components: no hit.sync-canon-copies.shandregen-collector-snapshots.sh: no change.agentskills validatewas not run, because no skill changed.CONTRIBUTING.md§ Writing documentation:README.md);path::symbolanchor, now with the debt overview's exception);docs/CONTEXT.md§ Conventions: a new page goes intoPAGES, and component links point atmaster.Not covered:
—or that a tech-debt row has a wake tag; the issue does not ask for it.Release Notes
docs/_archive/decisions.md: why the ecosystem is designed as it is, one row per decision with the page that holds its rule.docs/_backlog/debt-overview.md: every open tech-debt and epic issue of the seven repositories, findable by path, symbol or error code.Framework
docs/introduction/principles.mdin this PRRelated
Closes #137