Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jan 17, 2026

Documentation changes

This PR clarifies how custom icons work based on user feedback.


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

Refines documentation for clarity and consistency based on feedback.

  • Clarifies icon options/usage in organize/settings.mdx and snippets/icons-optional.mdx (adds concrete Font Awesome/Lucide examples, reorders options, removes JSX SVG mention from the icons note, and standardizes phrasing)
  • Multiple copy edits for concision and consistency (e.g., Google Fonts phrasing, link behavior, color application, timestamps, drilldown behavior)
  • Updates heading to ### API configurations
  • Adjusts Vale vocabulary by removing svg from the accepted terms

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

@ethanpalm ethanpalm merged commit d00f2f2 into main Jan 17, 2026
4 of 6 checks passed
@ethanpalm ethanpalm deleted the user-feedback-jan16 branch January 17, 2026 00:31
- URL to an externally hosted icon
- Path to an icon file in your project

- SVG code wrapped in curly braces
Copy link
Contributor

Choose a reason for hiding this comment

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

The steps below rely on SVGR/JSX output; calling that out here avoids readers thinking they can paste raw SVG (or use this in docs.json).

Suggested change
- SVG code wrapped in curly braces
- JSX-compatible SVG code wrapped in curly braces (MDX only)

subschema
Subscribable
subscribable
SVGs
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like svg was removed from the Vale accept list. Since the repo contains lots of inline <svg> (and .svg extensions), this might bring back linter noise unless Vale ignores those contexts.

Suggested change
SVGs
SVGs
svg

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