Skip to content

Conversation

@k-finken
Copy link
Contributor

@k-finken k-finken commented Dec 16, 2025

Documentation changes

Update the docs to add detail around custom snippet directories (has not shipped yet, will ship very soon).


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

Adds documentation for configuring additional snippet directories in docs.json and updates related import guidance.

  • Reusable snippets (create/reusable-snippets.mdx):
    • Add Snippet locations and Custom snippet directories with docs.json snippets glob support, examples, and import paths.
    • Clarify that files in snippet dirs aren’t standalone pages; updated tip to include custom paths.
    • Update pre-condition to allow custom snippet directories; add keyword.
  • React components (customize/react-components.mdx):
    • Update importing guidance to allow components from any configured snippet directory; link to custom snippet directories.
  • Settings reference (organize/settings.mdx):
    • Add new "snippets" array field to docs.json reference with example and link to reusable snippets.

Written by Cursor Bugbot for commit 2d0a036. This will update automatically on new commits. Configure here.

@ethanpalm
Copy link
Collaborator

closing for #2363

@ethanpalm ethanpalm closed this Dec 16, 2025
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.

3 participants