Skip to content

Conversation

@dino475
Copy link
Contributor

@dino475 dino475 commented Jul 30, 2025

Documentation changes

Updated the icon field in the accordions page to explain how to use custom SVG code


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

@dino475
Copy link
Contributor Author

dino475 commented Jul 30, 2025

@ethanpalm LMK what you think here - we might want to update this across the docs

@ethanpalm
Copy link
Collaborator

@dino475 do you know if there are any features that accept icons that don't allow for all of

  • Lucide
  • Font Awesome
  • SVGs
  • URL to external icon
  • Relative path to icon stored in the repo with docs

Since a lot of features can use icons, I think a snippet with consistent information is the way to go. I'll push that change to your branch.

@ethanpalm
Copy link
Collaborator

Created snippets for optional/required icon properties and added them to the relevant pages.

@ethanpalm ethanpalm merged commit 1aaae5f into main Aug 5, 2025
5 checks passed
@ethanpalm ethanpalm deleted the update-icon-field branch August 5, 2025 16:22
@JazzyMichael JazzyMichael mentioned this pull request Sep 24, 2025
11 tasks
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.

2 participants