feat(rspress-custom-theme): add custom icons documentation#36
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
Add icon re-export examples covering inline SVG, SVGR imports, and URL strings, along with the full list of 27 available built-in icons.
9b45753 to
dc560bb
Compare
There was a problem hiding this comment.
Code Review
This pull request introduces a new skill, rspress-custom-theme, with detailed documentation on customizing Rspress themes, including a new section on icons. The changes are well-structured and add valuable information.
My review identified one high-severity issue based on the repository's style guide. The guide requires that adding a new skill must be accompanied by an update to the main README.md to ensure discoverability. This update is missing. I have also suggested a minor clarification in the documentation to improve accuracy. After addressing the README.md update, the PR will be ready.
I am having trouble creating individual review comments. Click here to see my feedback.
skills/rspress-custom-theme/SKILL.md (1-4)
According to the repository's style guide, when a new skill is added, the root README.md file must be updated to include it. This pull request adds the rspress-custom-theme skill, but README.md has not been modified.
Please update README.md to:
- Add
rspress-custom-themeto the Table of Contents underRspress Skills. - Add a new section for
rspress-custom-themeunder the "Rspress Skills" heading, including the skill name, installation command, and a brief description.
This is required for discoverability and to adhere to the project's contribution guidelines.
References
- The repository style guide (lines 5, 6, 9, 11) mandates that when a new skill is added, the
README.mdfile must be updated to include a new section for the skill and the table of contents must be synchronized. Failure to do so is considered a high-severity issue. (link)
skills/rspress-custom-theme/SKILL.md (185)
The documentation states there are 27 built-in icons, and this list contains exactly 27. The etc. at the end is misleading as it implies the list is incomplete. For clarity, it's better to remove it to indicate that this is the full list.
**Available icons**: `IconArrowDown`, `IconArrowRight`, `IconClose`, `IconCopy`, `IconDeprecated`, `IconDown`, `IconEdit`, `IconEmpty`, `IconExperimental`, `IconExternalLink`, `IconFile`, `IconGithub`, `IconGitlab`, `IconHeader`, `IconJump`, `IconLink`, `IconLoading`, `IconMenu`, `IconMoon`, `IconScrollToTop`, `IconSearch`, `IconSmallMenu`, `IconSuccess`, `IconSun`, `IconTitle`, `IconWrap`, `IconWrapped`
There was a problem hiding this comment.
Pull request overview
Adds and expands documentation for the rspress-custom-theme skill to help users choose the right Rspress v2 customization approach, with new reference pages and an expanded section on custom icon replacement via theme/index.tsx re-exports.
Changes:
- Added three new reference docs: CSS variables, Layout slots, and component ejection workflows.
- Expanded
SKILL.mdwith a decision flow,theme/index.tsxpatterns, and a new “Custom Icons” section. - Updated the repository dictionary to include
rgba.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/rspress-custom-theme/references/layout-slots.md | New reference doc enumerating Layout slots and usage patterns. |
| skills/rspress-custom-theme/references/eject-components.md | New reference doc explaining rspress eject, available components, and override patterns. |
| skills/rspress-custom-theme/references/css-variables.md | New reference doc listing theme CSS variables and defaults + a quick-start snippet. |
| skills/rspress-custom-theme/SKILL.md | Main skill doc with decision flow, theme/index.tsx guidance, and custom icons documentation. |
| scripts/dictionary.txt | Adds rgba to spelling dictionary. |
Comments suppressed due to low confidence (1)
skills/rspress-custom-theme/SKILL.md:16
- “Level 1A” is referenced here and below, but there’s no Level 1A defined in the decision flow (only Level 1 with two options). Consider renaming these references to something like “Level 1 (Option A)” / “Level 1 with theme/index.tsx” to avoid confusion.
2. **Pick the right level** using the decision flow below
3. **Set up `theme/index.tsx`** if needed (Levels 1A, 3, 4 all need it)
4. **Implement** following the patterns in this skill and reference files
5. **Verify** the user's Rspress version is v2 (imports use `@rspress/core/*` not `rspress/*`)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add rspress-custom-theme to README.md for discoverability - Remove misleading "etc." from complete icons list - Add React type import to Icon type snippet
Summary
rspress-custom-themeskill with three usage patterns: inline SVG component, SVGR import, and URL stringSvgWrapperusage exampleTest plan
theme/index.tsxpattern