Repository navigation
Add links and a version timeline to the Go brief - #7
Merged
Merged
Conversation
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>
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.
Summary
go 1.23+ line ingo.moduntil Go 1.27 removed theasynctimerchanopt-out.scripts/check_links.py. Fetches every external link in the given briefs (default: all), checks that each page loads and each#anchorexists, 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.## Timelinesection 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.docs/javascripts/external-links.js, loaded throughextra_javascript, setstarget="_blank"andrel="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.target="_blank"; no site links do.🤖 Generated with Claude Code