feat(rspress-generate-docs): add skill for generating and maintaining rspress docs#75
Draft
SoonIter wants to merge 4 commits into
Draft
feat(rspress-generate-docs): add skill for generating and maintaining rspress docs#75SoonIter wants to merge 4 commits into
SoonIter wants to merge 4 commits into
Conversation
… Rspress v2 docs - Add SKILL.md with workflow for creating new docs, maintaining docs for PRs, and migrating Rspress v1 to v2. - Add reference docs covering project scaffolding (including getting-started link, templates, Node version, and Rslib integration), PR-driven updates, v1→v2 migration, and doc structure conventions with _nav.json/_meta.json. - Add evals/evals.json with test prompts for the three workflows. - Register the skill in README.md.
- Rename skill directory and update SKILL.md frontmatter/title. - Update README.md skill list and move rspress-docs-generator to the top of the Rspress Skills section. - Update evals/evals.json skill_name and fixture_root paths. - Rename local workspace directory for consistency.
SoonIter
force-pushed
the
feat/rspress-generate-docs-skill
branch
from
b6dc486 to
92b02d0
Compare
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.
Summary
Add a new
rspress-generate-docsskill that helps generate and maintain Rspress documentation for projects.What's included
skills/rspress-generate-docs/SKILL.md— high-level workflow for inspecting a project and choosing the right docs path.references/create-new-docs.md— scaffold a Rspress v2 docs site from an undocumented project, including Rslib integration and package-manager-aware setup.references/maintain-docs-for-prs.md— update an existing Rspress v2 docs site based on PR descriptions, linked issues, or branch diffs.references/migrate-rspress-v1.md— migrate an existing Rspress v1 docs site to v2 via the official migration guide.references/doc-structure-conventions.md— concrete_nav.json/_meta.jsonexamples for Guide/API sites, grouped sections, and i18n layouts.README.md— register the new skill in the skills list.Scope note
Evals (
skills/rspress-generate-docs/evals/evals.json) are intentionally excluded from this PR and will be added separately.Checklist