Skip to content

Give the two flagged endpoint URLs a resolving reference - #14

Open
Sande33p wants to merge 1 commit into
mainfrom
docs/resolve-flagged-urls
Open

Sande33p wants to merge 1 commit into
mainfrom
docs/resolve-flagged-urls

Conversation

@Sande33p

Copy link
Copy Markdown
Collaborator

Closes the last two link items from the v0.1.0 review (#2).

Both proxy.alcf.anl.gov:3128 and rest.kegg.jp/list/organism were already backticked code rather than links — an HTTP proxy endpoint and a REST endpoint — so neither was link rot, and both correctly fail a browser GET. But a reader hitting them had nothing to follow, and a link scanner nothing to resolve.

Each now cites a page that does resolve, beside the literal value: the ALCF getting-started docs for the proxy, and the KEGG REST API reference for the endpoint. Both return 200. The literal values stay — they are configuration a reader needs.

Type of Change

  • Documentation update

Compatibility

  • None of the above

How Has This Been Tested?

ruff clean; tools/ci/check_doc_links.py resolves all relative links. Docs-only change.

New Dependencies, Data, or Assets

None.

AI/LLM Assistance

  • AI/LLM tools were primarily used to generate code or artifacts in this PR
  • I have reviewed all such output line-by-line and understand it

🤖 Generated with Claude Code

The v0.1.0 review (#2) flagged `proxy.alcf.anl.gov:3128` and
`rest.kegg.jp/list/organism` as broken links. Both were already
backticked code rather than links -- an HTTP proxy endpoint and a REST
endpoint -- so neither was link rot, and both correctly fail a browser
GET. But a reader hitting them has nothing to follow, and a link scanner
has nothing to resolve.

Each now cites a page that does resolve, beside the literal value: the
ALCF getting-started docs for the proxy, and the KEGG REST API reference
for the endpoint. The values themselves stay, because they are
configuration a reader needs.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@Sande33p
Sande33p requested a review from a team as a code owner October 20, 2026 09:26
@Sande33p Sande33p mentioned this pull request Oct 20, 2026
20 of 31 tasks
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