Conversation
Update the build command to use 'pnpm build' instead of calling 'rspress build' directly, ensuring consistency with the project's build setup. Also URL-encode Chinese characters in redirect paths to properly handle internationalized URLs and ensure correct HTTP redirect behavior.
Redesigned the docs landing page with a new hero section, install shortcuts, richer topic links, and a preview image. Adds Phosphor icon support and custom platform icon SVGs, plus homepage styling updates for the new layout and responsive behavior.
Point the homepage Docker quick link to the Docker Compose installation guide so it matches the current documentation structure.
This change refines the guide sidebar layout and labels to better reflect the documentation hierarchy. It adds a new contribution section, updates overview page titles for the guide, install, and use sections, and removes redundant index entries from install/use directories so the navigation behaves more cleanly.
This change updates the code action icon styling so the copy/expand buttons use a muted gray color in the docs theme. It keeps the button group visually consistent without affecting other UI styles.
Enable unplugin-icons in the Rspress build and add Mingcute moon/sun icon exports for the docs theme. This keeps icon imports bundled correctly and makes theme icon assets reusable across the site.
Upgrade `@rspress/core` and `@rspress/plugin-sitemap` to 2.0.21, and update `pnpm-workspace.yaml` release-age exclusions to allow 2.0.21 for `@rspress/core`, `@rspress/shared`, and `@rspress/plugin-sitemap`.
Replaced custom Phosphor React imports with Iconify-backed icons on the docs homepage, including Docker and 1Panel branding. Added the required Iconify packages, removed the custom PlatformIcons helper, and adjusted the nav menu spacing CSS to match the updated layout. This keeps the homepage consistent with the site’s icon system and removes redundant custom icon code.
Rename `theme/override.css` to `theme/override.scss` and update the theme entry import accordingly. Add `theme/css.d.ts` so TypeScript accepts CSS/SCSS module imports, and relocate the code button icon color override from `styles/index.scss` into the theme override stylesheet (also removing `!important`).
Add `image.checkDeadImages` to the Rspress config so the docs build flags broken local images and catches missing assets earlier during validation.
This change adds `description` frontmatter to documentation pages across the developer guide and user guide. The metadata improves SEO, page previews, and navigation clarity without changing the underlying documentation content.
Expanded and clarified `description` fields across core, plugin, theme, contribution, and index documentation pages to better summarize each page’s scope and key concepts. Also removed the unused `docs/developer-guide/plugin/appendices.md` placeholder page.
Refines homepage layout density by reducing button height/padding in `.docs-hero__platforms` and shrinking quick-start card row sizes, min-heights, and internal spacing. Also updates responsive quick-start dimensions so the compact sizing is consistent on smaller screens.
Update `theme/override.scss` to customize the overview search input background and focus/active states for both light and dark themes, improving visual consistency with the rest of the site.
Replace the generic BaoTa panel icon on the docs homepage with a custom SVG logo, and register a custom icon collection in the Rspress icon plugin to load it. Biome's SVG title accessibility rule is disabled so the imported logo passes linting.
This change adds dedicated AI assistance pages for Halo plugin and theme development, including installation and usage instructions for the official halo-plugin-dev and halo-theme-dev Agent Skills. It also removes the duplicated AI sections from the prepare guides and updates the navigation metadata to surface the new docs alongside the existing developer setup material.
Refine `docs/index.mdx` to better support translation and screen readers by marking the Halo brand as non-translatable and hiding decorative icons and external-link arrows from assistive tech. The update also standardizes platform icon sizing and marks the hero image as high priority to improve initial page loading.
Delete a large set of screenshot assets from `docs/public/img` across the guide, install, migration, and developer sections. This cleans up outdated or no-longer-needed documentation images and reduces repository bloat.
Adjust homepage topic and quick-start styles for better readability and visual hierarchy. This updates muted text colors, turns topic groups into soft-background cards with tighter grid spacing, improves icon hover transitions, and restyles the “view all” link to use neutral text with brand-color hover feedback.
Update both developer AI-assistance pages to support two onboarding paths: supplying Halo documentation URLs directly to AI tools or installing the official Agent Skill. Added a new “提供文档上下文” section with llms.txt and focused index.md links, refined frontmatter descriptions, and adjusted “安装/使用” to subheadings under the Agent Skill section for clearer structure.
This change updates the theme override for code button group icons to add a hover state color. It improves the visual feedback when users hover over code action icons in the docs site.
Added descriptive titles to info, warning, note, and tip callouts across installation and usage guides. This makes key guidance easier to scan and understand at a glance without changing the underlying documentation content.
Replace the Markdown JAR deployment guide with an MDX version that uses Rspress `Steps` to organize installation, service setup, and upgrade instructions into clearer step-by-step sections while preserving the existing deployment content.
Restructure the Docker deployment guide with Rspress Steps to make installation and upgrade instructions easier to follow. This update groups the setup flow into clearer sections, keeps the command examples together, and improves readability without changing the underlying deployment steps.
Refines multiple installation guides to correct and modernize command examples and config snippets: uses `docker compose` syntax, adds JVM memory opts to Docker upgrade commands, and fixes Helm output formatting plus the external MySQL toggle (`mysql.enabled=false`). It also improves Traefik setup steps (including ACME storage), and updates Podman/Quadlet examples for SELinux volume labels (`:Z`), host DB connectivity via `host.containers.internal`, and aligned service options.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3f85719236
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Comment on lines
+199
to
+200
| --- | ||
| lockfileVersion: '9.0' |
There was a problem hiding this comment.
The second YAML document beginning here makes the lockfile unreadable: running pnpm install against this commit reports ERR_PNPM_BROKEN_LOCKFILE because it expects a single document. Consequently, both the CI workflow's install step and the deployment install command fail before the Rspress site can be checked or built; regenerate the lockfile as one document rather than concatenating the package-manager bootstrap lock with the project lock.
AGENTS.md reference: AGENTS.md:L18-L18
Useful? React with 👍 / 👎.
|
|
||
| ``` | ||
| $ pnpm start | ||
| pnpm start |
There was a problem hiding this comment.
The migrated package.json no longer defines a start script and instead exposes dev, so contributors following this command receive ERR_PNPM_NO_SCRIPT rather than starting Rspress. Change the documented command to pnpm dev.
AGENTS.md reference: AGENTS.md:L12-L12
Useful? React with 👍 / 👎.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
This promotes the Rspress migration merged into
devthrough #621 together with its follow-up refinements.Validation
pnpm check:cigit diff --check origin/main...HEADpnpm build3f85719