docs: link concepts pages relatively, not via docs.minimal.dev - #1094
Conversation
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
📝 WalkthroughWalkthroughReference 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. ChangesReference documentation updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
docs/reference/build-specs.mddocs/reference/minimal-dot-toml.mddocs/reference/stack-specs.mddocs/reference/tasks.md
| 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`. |
There was a problem hiding this comment.
🎯 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.
Eight links in the reference docs point at
https://docs.minimal.dev/concepts/...instead of the relative../concepts/*.mdform used everywhere else. That breaks GitHub-native reading (no in-repo navigation) and bounces readers of the webapp's/docsrendering out to the external host.This converts all eight to relative links. All targets exist in
docs/concepts/. Deliberately untouched:tasks.md'secho = "Docs live at https://docs.minimal.dev"(example content, not a link) and the prose mention indocs/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