Skip to content

chore: style edits for assistant skills - #6369

Merged
ethanpalm merged 2 commits into
mainfrom
docs/skills-style-pass
Jul 2, 2026
Merged

chore: style edits for assistant skills#6369
ethanpalm merged 2 commits into
mainfrom
docs/skills-style-pass

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Documentation changes

Brief description of what's being updated

Closes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Docs-only wording and layout changes with no runtime or product behavior changes.

Overview
assistant/customize.mdx moves the pointer to skills out of inline prose into a Tip component, framed as topic-specific guidance loaded only when a question matches.

assistant/skills.mdx is a broader editorial pass: refreshed frontmatter description, tighter intro and “use skills” bullets, clearer file-structure and skill.md examples, and wording that says redeploy instead of “publish your docs” / “discovered on your next documentation update.” The How the assistant uses skills section is rewritten as short paragraphs (no bullet list) and no longer names the loadSkill tool explicitly. Skill authoring tips is renamed Write effective skills with simplified bullets. Disable skills now documents deleting .mintlify/assistant/skills/ and redeploying before contacting support.

Reviewed by Cursor Bugbot for commit 9c87ec7. Bugbot is set up for automated code reviews on this repo. Configure here.

ethanpalm and others added 2 commits July 2, 2026 14:40
Align the assistant skills page (added in #6363) with docs style
standards: tighter intro without promotional language, language tag
on the directory tree code block, active voice, prose instead of a
behavior bullet list, and action-oriented headings.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 2, 2026, 10:20 PM

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
smartac 🟡 Building Jul 2, 2026, 10:21 PM

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

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
testsignup415 🟡 Building Jul 2, 2026, 10:21 PM

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

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
adminroletesting 🟡 Building Jul 2, 2026, 10:21 PM

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

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
hfh-d7a4d643 🟡 Building Jul 2, 2026, 10:21 PM

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

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
gwgwgw 🟡 Building Jul 2, 2026, 10:21 PM

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

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 2, 2026, 10:21 PM

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

@ethanpalm
ethanpalm merged commit 1c693a1 into main Jul 2, 2026
6 checks passed
@ethanpalm
ethanpalm deleted the docs/skills-style-pass branch July 2, 2026 22:22
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.

1 participant