Skip to content

Conversation

@k-finken
Copy link
Contributor

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

Documentation changes

We are refactoring the snippets solution this removes the documentation around it so we don't encourage people to use something that will be deprecated 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

Removes docs for custom snippet directories and updates guidance to require components/snippets be imported from /snippets/ only.

  • Docs updates (snippets):
    • Remove snippets configuration from docs.json reference (organize/settings.mdx).
    • create/reusable-snippets.mdx:
      • Delete “Configure snippet folders” section.
      • Update absolute import guidance to only use /snippets/.
    • customize/react-components.mdx:
      • Clarify React components must live under /snippets/ and adjust copy accordingly.

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

We are refactoring the snippets solution this removes the documentation around that solution and refactors it
Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

lgtm!

@k-finken k-finken merged commit 80384c6 into main Dec 18, 2025
6 checks passed
@k-finken k-finken deleted the Kyle/remove-snippets-docs-json-stuff branch December 18, 2025 21: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