Skip to content

Add links to the system and distributed briefs - #8

Merged
pinebit merged 2 commits into
mainfrom
system-distributed-links
Oct 7, 2026
Merged

pinebit merged 2 commits into
mainfrom
system-distributed-links

Conversation

@pinebit

@pinebit pinebit commented Oct 7, 2026

Copy link
Copy Markdown
Owner
  • Links terms in docs/topics/system.md and docs/topics/distributed.md to official docs, RFCs, papers, and Wikipedia, following the linking rules in AGENTS.md. Concepts owned by another brief (CDC, idempotency keys) link to that file.
  • Removes bold from both briefs. Apart from links and bold, the text is unchanged except the Kafka log compaction bullet, which now says compaction runs in the background and keeps at least the latest record per key.
  • scripts/check_links.py now recognizes unquoted and single-quoted id/name attributes, which the WHATWG HTML spec and the Kafka docs use, and ignores suffixed attributes such as data-id.

Kafka doc links point at the versioned kafka.apache.org/43/ pages; the site has no unversioned deep links.

Checked with python scripts/check_links.py on both briefs and the Go brief (449 links, 0 problems), python scripts/lint_briefs.py, and zensical build --clean --strict.

🤖 Generated with Claude Code

pinebit and others added 2 commits October 7, 2026 21:46
Minified pages such as the WHATWG HTML spec and the Kafka docs write
id attributes without quotes, so the checker reported their anchors as
missing. Accept double-quoted, single-quoted, and unquoted values, and
skip suffixed attributes such as data-id.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Link terms in the system design and distributed systems briefs to
official docs, RFCs, papers, and Wikipedia, and link concepts owned by
another brief to that file. Remove bold from both briefs per the format
rules. Reword the Kafka log compaction bullet: compaction runs in the
background and keeps at least the latest record per key.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pinebit
pinebit merged commit ee5c917 into main Oct 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant