Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Dec 16, 2025

Documentation changes

This updates the snippets documentation with regard to

  • relative and absolute imports
  • custom snippet folders
  • general rewriting to be more clear

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

Refreshes snippets documentation with clearer usage, adds docs.json support for custom snippet folders, and updates React components/importing and settings reference accordingly.

  • Snippets docs (create/reusable-snippets.mdx):
    • Add Configure snippet folders: define additional snippet locations via docs.json snippets (glob patterns).
    • Clarify imports: absolute (/snippets/... or custom roots) vs relative; add IDE navigation tip.
    • Expand examples: importing text snippets, referencing exported variables, passing props to snippets, importing React components; note to use arrow functions in snippets.
  • React components (customize/react-components.mdx):
    • Clarify importing from snippet folders; note default /snippets/ and configurable directories via docs.json.
  • Settings reference (organize/settings.mdx):
    • Add snippets array field to docs.json with example configuration for additional snippet folders.

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

Copy link
Contributor

@k-finken k-finken left a comment

Choose a reason for hiding this comment

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

thank you!

@ethanpalm ethanpalm merged commit c6eddf0 into main Dec 17, 2025
5 checks passed
@ethanpalm ethanpalm deleted the snippets-v3 branch December 17, 2025 02:56
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