Repository navigation
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Collaborator
🟡 Heimdall Review Status
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed? Why?
Follow-up to #2142, addressing this review: the rule for hiding interactive demos from agents should live in the docs style guide, not only in
claude.md.docs/content-guidelines.md: new Interactive Demos section under Writing Rules. It explains why (Mintlify inlines each imported JSX component's full source into the page's Markdown export) and sets the pattern: wrap the demo, its## Demoheading, and any demo-only callout in<Visibility for="humans">; keep version notes, addresses, warnings, and Steps outside; wrap every use of the component on the page. Includes a copyable example..claude/skills/doc-feedback.md: adds a checklist item so the doc review skill checks for it.Notes to reviewers
docs/content-guidelines.mdis a protected surface and needs 1 Governance Owner approval.claude.mdfrom docs: hide interactive demos from agent Markdown #2142 is unchanged.How has it been tested?
npm test: all passnode scripts/check-terminology.js: passdocs.jsonchanged.Screenshots
N/A (no user-facing changes)
Generated with Toshi