Skip to content

docs: link concepts pages relatively, not via docs.minimal.dev - #1094

Merged
twitchyliquid64 merged 1 commit into
mainfrom
docs/relative-links-not-docs-host
Jul 29, 2026
Merged

docs: link concepts pages relatively, not via docs.minimal.dev#1094
twitchyliquid64 merged 1 commit into
mainfrom
docs/relative-links-not-docs-host

Conversation

@agent-137

@agent-137 agent-137 commented Jul 29, 2026

Copy link
Copy Markdown
Member

Eight links in the reference docs point at https://docs.minimal.dev/concepts/... instead of the relative ../concepts/*.md form used everywhere else. That breaks GitHub-native reading (no in-repo navigation) and bounces readers of the webapp's /docs rendering out to the external host.

This converts all eight to relative links. All targets exist in docs/concepts/. Deliberately untouched: tasks.md's echo = "Docs live at https://docs.minimal.dev" (example content, not a link) and the prose mention in docs/internal/release-pipeline.md.

Context: found while shipping gominimal/webapp#491 — the webapp now also rewrites these at render time (rewriteDocsHostHref), which keeps older promoted shas working; this PR fixes the source of truth so newly synced docs are right by construction.

🤖 Generated with Claude Code

https://claude.ai/code/session_01K131eRfYxJ5YdY1v3iMULi

Note

Convert absolute docs.minimal.dev links to relative paths in reference docs

Updates concept links in four reference docs (build-specs.md, minimal-dot-toml.md, stack-specs.md, tasks.md) to use relative paths instead of absolute URLs pointing to docs.minimal.dev. This ensures links work correctly in local previews and non-production environments.

Macroscope summarized 57d5c32.

Summary by CodeRabbit

  • Documentation
    • Updated reference documentation links to use local pages for packages, software supply chains, stacks, and sessions.
    • Improved readability of session configuration guidance by separating related descriptions into distinct paragraphs.

Eight reference-page links pointed at the absolute docs host instead of
the relative ../concepts/*.md form the rest of the docs use. Absolute
links break GitHub-native reading of the repo docs and bounce readers of
any downstream rendering (minimal.dev/docs) out to the external host. All
eight targets exist in docs/concepts/; the docs.minimal.dev mentions that
are prose or example content (tasks.md's echo sample, the internal
release-pipeline note) are unchanged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01K131eRfYxJ5YdY1v3iMULi
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Reference documentation now uses relative links to local concept pages. The session section in the TOML reference is reorganized into separate paragraphs while preserving its meaning.

Changes

Reference documentation updates

Layer / File(s) Summary
Concept link normalization
docs/reference/build-specs.md, docs/reference/minimal-dot-toml.md, docs/reference/stack-specs.md, docs/reference/tasks.md
External concept URLs are replaced with relative links to local package, software supply chain, stacks, and related documentation.
Session reference reorganization
docs/reference/minimal-dot-toml.md
The session defaults description is split into paragraphs, and the sessions reference uses a relative link.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: twitchyliquid64

Poem

I’m a rabbit with links in my den,
Now local paths guide readers again.
Packages and stacks,
Supply chains on tracks,
Sessions hop neatly from page to page!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, but it omits the required Summary/Testing/Checklist structure and has no testing evidence. Add the template sections Summary, Testing, and Checklist, and include the relevant test or validation steps performed.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly states the core change: converting docs concept links to relative paths instead of the docs.minimal.dev host.

Comment @coderabbitai help to get the list of available commands.

@mitodrummer
mitodrummer requested a review from norrietaylor July 29, 2026 23:51

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/reference/minimal-dot-toml.md`:
- Around line 118-120: Update the documentation for defaults.profile and
defaults.state_key to state that each default applies to all tasks and sessions
that do not explicitly set the corresponding value. Preserve the existing
wording and links while restoring the documented session scope.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3c4f8bc4-bf49-4c2a-92dd-86df6738f5ed

📥 Commits

Reviewing files that changed from the base of the PR and between 60ad21c and 57d5c32.

📒 Files selected for processing (4)
  • docs/reference/build-specs.md
  • docs/reference/minimal-dot-toml.md
  • docs/reference/stack-specs.md
  • docs/reference/tasks.md

Comment on lines +118 to 120
When set, `defaults.profile` will set a [profile](../concepts/profiles.md) on all tasks which do not set a profile.

When set, `defaults.state_key` will set a state key on all tasks which do not set `state_key`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Preserve the documented session scope for defaults.

These sentences now say defaults.profile and defaults.state_key apply only to tasks, while the supplied change context indicates the behavior also covers sessions. Retain the session scope, e.g. “all tasks and sessions which do not set …”.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/reference/minimal-dot-toml.md` around lines 118 - 120, Update the
documentation for defaults.profile and defaults.state_key to state that each
default applies to all tasks and sessions that do not explicitly set the
corresponding value. Preserve the existing wording and links while restoring the
documented session scope.

@mitodrummer
mitodrummer enabled auto-merge (squash) July 29, 2026 23:54
@twitchyliquid64
twitchyliquid64 disabled auto-merge July 29, 2026 23:58
@twitchyliquid64
twitchyliquid64 merged commit 67d0b77 into main Jul 29, 2026
28 checks passed
@twitchyliquid64
twitchyliquid64 deleted the docs/relative-links-not-docs-host branch July 29, 2026 23:58
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.

4 participants