Skip to content

Add links and a version timeline to the Go brief - #7

Merged
pinebit merged 4 commits into
mainfrom
golang-links-and-timeline
Oct 7, 2026
Merged

pinebit merged 4 commits into
mainfrom
golang-links-and-timeline

Conversation

@pinebit

@pinebit pinebit commented Oct 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • No bold in briefs. AGENTS.md now says to put identifiers, flags, commands, and file names in code formatting and leave out bold. Bold is removed from the Go brief and the AGENTS.md example. The quiz skill grades answers against each concept's key fact, number, or gotcha instead of its bold terms. Other briefs still use bold; the linter's limit of 3 bold terms per concept stays until they are converted.
  • Links in the Go brief. Standard library names, language features, and tooling link to pkg.go.dev, the Go spec, the modules reference, the FAQ, Effective Go, the GC guide, release notes, and the Go blog; general CS terms link to Wikipedia. A term is linked at its first mention in each concept. The timer bullet now states that the Go 1.23 timer behavior required a go 1.23+ line in go.mod until Go 1.27 removed the asynctimerchan opt-out.
  • scripts/check_links.py. Fetches every external link in the given briefs (default: all), checks that each page loads and each #anchor exists, and exits 1 on problems. It is not run in CI because it depends on the network. AGENTS.md documents it and the linking rules.
  • Timeline. A ## Timeline section at the top of the Go brief has two tables (language and runtime; library and tooling) covering Go 1.13–1.27, linked to the release notes. AGENTS.md documents it as an optional section for language and tool briefs, placed first.
  • External links open in a new tab. docs/javascripts/external-links.js, loaded through extra_javascript, sets target="_blank" and rel="noopener" on content links to other hosts. Navigation, table of contents, and cross-topic links stay in the current tab.

Testing

  • python scripts/lint_briefs.py: passes after each commit.
  • zensical build --clean --strict: passes.
  • python scripts/check_links.py: 187 links across all briefs (184 in the Go brief), 0 problems. Also checked against a sample file with a bad anchor and a 404; both were reported, with exit code 1.
  • Rendered the Go page in headless Chrome: all 184 external content links have target="_blank"; no site links do.

🤖 Generated with Claude Code

pinebit and others added 4 commits October 7, 2026 21:15
Make "no bold" the brief format rule: identifiers go in code formatting
and the wording carries emphasis. Remove bold from the Go brief and the
AGENTS.md example, and grade quiz answers against each concept's key
fact instead of its bold terms. Other briefs are converted later.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Link standard library names, language features, and tooling in the Go
brief to pkg.go.dev, the spec, the modules reference, and release notes,
and general CS terms to Wikipedia. Add scripts/check_links.py, which
fetches each external link and checks that its #anchor exists, and
document the linking rules in AGENTS.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add a Timeline section listing key language, runtime, library, and
tooling changes from Go 1.13 to 1.27, each linked to its release notes.
Document the optional Timeline section in AGENTS.md as the one exception
to ordering sections by interview frequency.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add a script that sets target="_blank" and rel="noopener" on links in
page content that point to another host. Navigation, table of contents,
and cross-topic links stay in the current tab.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pinebit
pinebit merged commit 9925d34 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