Skip to content

docs: unlist the Send-to guide from the docs nav (tool-served, not web-searched) - #2918

Merged
somanshreddy merged 1 commit into
mainfrom
07-31-hide_send_to_guide_from_docs_nav
Jul 31, 2026
Merged

docs: unlist the Send-to guide from the docs nav (tool-served, not web-searched)#2918
somanshreddy merged 1 commit into
mainfrom
07-31-hide_send_to_guide_from_docs_nav

Conversation

@somanshreddy

Copy link
Copy Markdown
Contributor

What

Unlist the "Send to HyperFrames" authoring guide (guides/claude-design-send-to-hyperframes) from the docs navigation in docs.json, making it an unlisted orphan file (like the sibling claude-design-hyperframes.md already is). The guide file itself is unchanged.

Why

That guide is an internal authoring contract for the Claude Design "Send to HyperFrames" import flow, not general HyperFrames product docs. It's now delivered exclusively by the get-send-to-hyperframes-guide MCP tool, which fetches the raw file server-side (raw.githubusercontent.com/heygen-com/hyperframes/main/docs/guides/claude-design-send-to-hyperframes.md) and returns it as tool-result data — independent of the docs site. The llms.txt / web_search discovery path it was published for is no longer used (the import tool tells the agent the guide comes from the tool, "no fetch/search needed"). So the nav entry only surfaces implementation detail in the public product docs without serving the flow.

How

Remove the one "guides/claude-design-send-to-hyperframes" line from docs/docs.json. This drops it from the sidebar and the auto-generated llms.txt, while:

  • keeping the .md file at its path — the MCP tool's raw fetch URL depends on it and is unchanged, so nothing in the live flow moves;
  • keeping the redirect note in claude-design-hyperframes.md (it points at the raw GitHub URL, not the docs page, so it still resolves).

Orphan guide files build cleanly in this repo — claude-design-hyperframes.md is already an orphan (present but absent from docs.json), and no internal doc links reference the page.

Test plan

  • docs.json validated as well-formed JSON; guide .md confirmed still present; grep confirms no internal doc links to the page.
  • Manual testing performed
  • Documentation updated (if applicable)

…b-searched)

The "Send to HyperFrames" authoring guide is an internal contract for the Claude
Design import flow, delivered exclusively by the get-send-to-hyperframes-guide MCP
tool (raw server-side fetch of the .md, returned as tool-result data). The llms.txt /
web_search discovery path it was published for is no longer used. Drop it from
docs.json so it stops appearing in the public product docs nav + llms.txt; keep the
.md file at its path (the tool's raw fetch URL depends on it) and the redirect note in
claude-design-hyperframes.md (points at the raw URL, not the docs page). Orphan guide
files build cleanly here (claude-design-hyperframes.md already is one).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hyperframes 🟢 Ready View Preview Jul 31, 2026, 7:36 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@miguel-heygen miguel-heygen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approved exact head 24bc93df12f78db5600b411991d489afb9fe68e9. This is the correct minimal separation: removing only the docs-nav entry unlists the internal Send-to contract (and its generated discovery surface) while preserving the raw GitHub file path consumed by the MCP tool. Both raw-link redirects remain valid, the existing semantic contract test still reads the unchanged file, and the sibling orphan guide establishes that unlisted files are supported. Exact-head docs validation/CodeQL/checks are terminal green; no unresolved review threads.

@somanshreddy
somanshreddy merged commit a3c8f89 into main Jul 31, 2026
43 checks passed
@somanshreddy
somanshreddy deleted the 07-31-hide_send_to_guide_from_docs_nav branch July 31, 2026 08:00
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.

2 participants