docs: use lucide icons instead of font awesome#77
Conversation
WalkthroughThis PR updates documentation icon identifiers across multiple MDX files (docs/cli.mdx, docs/guides/add-suga.mdx, docs/guides/local-database-setup.mdx, docs/introduction.mdx, docs/quickstart.mdx). It also adds a new top-level "icons" object with "library": "lucide" to docs/docs.json. No text, links, behavior, or public/exported entity signatures are changed. Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
docs/guides/add-suga.mdx (1)
34-34: Switch to Lucide: good, but align editor/brand icons.
- Nice: cog is a valid Lucide icon.
- Consistency: elsewhere “Open Suga Editor” uses pencil‑ruler; consider matching here (currently pencil).
- Lucide generally lacks brand icons (AWS/GCP). Recommend neutral Lucide fallbacks to avoid broken icons.
Apply diffs:
- <Step title="Configure Infrastructure" icon="cog"> + <Step title="Configure Infrastructure" icon="cog"> @@ - ```bash title="Open Suga Editor" icon="pencil" + ```bash title="Open Suga Editor" icon="pencil-ruler" suga edit ```- <Tab title="AWS"> - ```bash title="Configure AWS" icon="aws" + <Tab title="AWS"> + ```bash title="Configure AWS" icon="cloud" aws configure ``` @@ - <Tab title="GCP"> - ```bash title="Configure GCP" icon="google" + <Tab title="GCP"> + ```bash title="Configure GCP" icon="globe" gcloud auth application-default login ```Please preview the docs to confirm AWS/Google icons render after switching to lucide.
Also applies to: 37-39, 354-361
docs/quickstart.mdx (1)
40-40: Lucide swap OK; fix lingering Font Awesome name.
- pencil-line is Lucide.
- check-circle is FA; use circle-check for Lucide.
- ```bash title="Test Application" icon="check-circle" + ```bash title="Test Application" icon="circle-check"Optionally standardize editor icons to pencil‑ruler for consistency.
Also applies to: 179-179
docs/guides/local-database-setup.mdx (1)
53-55: Good Lucide renames; watch for brand icon “docker”.circle-check and pencil‑ruler are correct. Elsewhere this page uses icon="docker" which Lucide likely doesn’t provide; consider a neutral Lucide icon (e.g., package or boxes) to avoid broken renders.
- ```yaml title="docker-compose.yml" icon="docker" + ```yaml title="docker-compose.yml" icon="package"Please check that any remaining “docker” icons render post‑switch.
Also applies to: 63-65
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/cli.mdx(1 hunks)docs/docs.json(1 hunks)docs/guides/add-suga.mdx(1 hunks)docs/guides/local-database-setup.mdx(2 hunks)docs/introduction.mdx(1 hunks)docs/quickstart.mdx(1 hunks)
🔇 Additional comments (1)
docs/introduction.mdx (1)
176-178: Support card icon updated to Lucide “life-buoy” — looks good.
|
🎉 This PR is included in version 0.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Replaces the Font Awesome icons (which is the default in Mintlify) with Lucide. This matches the icon set we use on the website and app.