Skip to content

fix: point /docs command and config links to docs.altimate.sh#715

Merged
anandgupta42 merged 2 commits intomainfrom
fix/docs-url
Apr 17, 2026
Merged

fix: point /docs command and config links to docs.altimate.sh#715
anandgupta42 merged 2 commits intomainfrom
fix/docs-url

Conversation

@anandgupta42
Copy link
Copy Markdown
Contributor

@anandgupta42 anandgupta42 commented Apr 17, 2026

What does this PR do?

Fixes the TUI /docs command (and several config/help-text references) which pointed to https://altimate.ai/docs — not the project's docs site. The canonical docs live at https://docs.altimate.sh (per README.md, docs/docs/CNAME, docs/mkdocs.yml).

Updated references:

  • packages/opencode/src/cli/cmd/tui/app.tsx — "Open docs" command URL
  • packages/opencode/src/config/config.ts — config precedence comment + command/agent schema descriptions
  • packages/opencode/src/cli/cmd/providers.ts — Cloudflare AI Gateway help text
  • packages/opencode/src/session/prompt/anthropic.txt — Anthropic system prompt docs link
  • packages/sdk/openapi.json + generated packages/sdk/js/src/**/gen/types.gen.tscommand/agent schema descriptions

Also corrected the paths (e.g. /commands/configure/commands/) to match the actual mkdocs site structure.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Other

Issue for this PR

Closes #714

How did you verify your code works?

  • Ran curl -L -o /dev/null -w '%{http_code}' <url> against every updated URL — all return HTTP 200:
    • https://docs.altimate.sh
    • https://docs.altimate.sh/configure/config/
    • https://docs.altimate.sh/configure/commands/
    • https://docs.altimate.sh/configure/agents/
    • https://docs.altimate.sh/configure/providers/
  • Ran bun run script/upstream/analyze.ts --markers --base main --strictok No upstream-shared files modified — no markers needed.
  • Turbo typecheck passes for all workspace packages (pre-push hook).
  • No functional logic changed — string-only edits across user-facing URLs and generated SDK type comments.

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

No tests added — this is a string-only URL correction with no logic changes. The target URLs were manually verified to return HTTP 200.


Summary by cubic

Points the TUI /docs command and all in-app docs links to https://docs.altimate.sh. Also fixes paths to /configure/* so users land on the right pages.

  • Bug Fixes
    • TUI docs.open now opens https://docs.altimate.sh.
    • Fixed config precedence and schema description URLs to /configure/config/, /configure/commands/, and /configure/agents/.
    • Updated Cloudflare AI Gateway help text to /configure/providers/.
    • Updated Anthropic system prompt docs link.
    • Synced links in OpenAPI and generated SDK types.

Written for commit 344eb97. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links throughout the application to reference the new documentation site at docs.altimate.sh

The TUI "Open docs" command (`docs.open`) opened `https://altimate.ai/docs`,
which is not the project's documentation site. The canonical docs live at
`https://docs.altimate.sh` (per `README.md`, `docs/docs/CNAME`, `docs/mkdocs.yml`).

The same wrong domain was also used in `config.ts` schema descriptions,
the Cloudflare AI Gateway help text, the Anthropic system prompt, and
`openapi.json` + generated SDK type files. The rewritten paths also needed
a `/configure/` prefix to match the actual mkdocs site structure.

All 5 target URLs were verified to return HTTP 200:
- https://docs.altimate.sh
- https://docs.altimate.sh/configure/config/
- https://docs.altimate.sh/configure/commands/
- https://docs.altimate.sh/configure/agents/
- https://docs.altimate.sh/configure/providers/

Closes #714
Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 17, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5ac00a60-60e1-4df9-a186-b8394e2352db

📥 Commits

Reviewing files that changed from the base of the PR and between c438bb0 and 9d90c0c.

⛔ Files ignored due to path filters (2)
  • packages/sdk/js/src/gen/types.gen.ts is excluded by !**/gen/**
  • packages/sdk/js/src/v2/gen/types.gen.ts is excluded by !**/gen/**
📒 Files selected for processing (5)
  • packages/opencode/src/cli/cmd/providers.ts
  • packages/opencode/src/cli/cmd/tui/app.tsx
  • packages/opencode/src/config/config.ts
  • packages/opencode/src/session/prompt/anthropic.txt
  • packages/sdk/openapi.json

📝 Walkthrough

Walkthrough

Documentation URLs are updated across the codebase, transitioning from altimate.ai/docs to docs.altimate.sh with standardized /configure/ path prefixes for configuration-related endpoints. No functional or control flow changes were made.

Changes

Cohort / File(s) Summary
CLI and TUI Commands
packages/opencode/src/cli/cmd/providers.ts, packages/opencode/src/cli/cmd/tui/app.tsx
Documentation URLs updated from altimate.ai/docs to docs.altimate.sh for cloudflare provider login flow and "Open docs" command.
Configuration Schema and OpenAPI
packages/opencode/src/config/config.ts, packages/sdk/openapi.json
Zod schema descriptions and OpenAPI Config schema properties updated to point to new docs.altimate.sh/configure/ endpoints for command and agent configuration documentation.
System Prompt
packages/opencode/src/session/prompt/anthropic.txt
Documentation URL reference updated to docs.altimate.sh for cases where users inquire about Altimate Code features.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

Suggested labels

contributor

Suggested reviewers

  • suryaiyer95

Poem

🐰 Through docs we hop, from old to new,
Links updated, paths aligned in view,
From altimate.ai to altimate.sh we go,
Configuration routes with /configure/ flow,
A rabbit's work, both steady and true! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: updating /docs command and config links to use the correct docs.altimate.sh domain.
Description check ✅ Passed The description is comprehensive and covers all required template sections: it explains what changed and why, includes a detailed test plan with verification steps, and has a completed checklist.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-url

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@anandgupta42 anandgupta42 merged commit fda5078 into main Apr 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

/docs command and config doc links point to wrong domain

1 participant