Skip to content

Link companion docs back to the README#30

Merged
hibou04-ops merged 1 commit into
mainfrom
docs/companion-doc-backlinks
May 22, 2026
Merged

Link companion docs back to the README#30
hibou04-ops merged 1 commit into
mainfrom
docs/companion-doc-backlinks

Conversation

@hibou04-ops
Copy link
Copy Markdown
Owner

What

Adds a one-line backlink footer (English + Korean) to the six README-linked companion docs — trust_model.md, trust_model_kr.md, toolkit_positioning.md, toolkit_positioning_kr.md, examples.md, examples_kr.md — plus a CHANGELOG note.

Why

On GitHub, each file page shows the CI status of the commit that last modified that file. These six docs were last touched by 188c244 ("Prepare trust-first 0.10.0 release"), whose CI failed — the trust-check jobs were broken and fixed in the very next commit (769b322). So opening any of these docs via the README's Trust model / Toolkit positioning / CLI examples links showed a red ✗ next to the commit line, even though the files and links are correct and current main CI is green.

Re-touching the files in a green commit moves their last-modified pointer forward, so the badge reflects passing CI. The footer itself is a genuine small improvement — these companion docs previously had no navigation back to the README.

Scope

  • The links themselves were never broken; nothing on PyPI is affected.
  • Other files still last-touched by 188c244 (e.g. cli_exit_codes.md, provider_compatibility.md, EASY_README*, source modules) still carry the old badge — out of scope for this minimal fix.

🤖 Generated with Claude Code

The trust model, toolkit positioning, and CLI example gallery docs had
no navigation back to the README. Add a one-line backlink footer to
each (English and Korean).

These six files were last modified by the v0.10.0 commit, whose CI run
predated the trust-check test fix in the following commit, so GitHub
rendered a stale failing-CI badge on each file page. Re-touching them
in a green commit refreshes that status.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@hibou04-ops hibou04-ops merged commit 278a0a1 into main May 22, 2026
8 checks passed
@hibou04-ops hibou04-ops deleted the docs/companion-doc-backlinks branch May 22, 2026 20:28
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