docs: align webdocs and README with current CLI surface#187
Merged
Conversation
Reflect the command-surface changes from #183/#184 across all user-facing docs: - Remove the retired `sync` command everywhere; document that modern agents (Claude Code, Cursor, …) read skills directly from the skills directory with no metadata-file sync step. - Replace `fastskill show` with `fastskill read --meta` / `--tree` and `fastskill list`. - Document `fastskill doctor` and conditional (embedding-gated) reindex. - Add `search --local --paths/--content` (the machine path that replaced `resolve`). - Rewrite the Claude Code and Cursor integration pages around direct discovery + MCP; drop the fictional markdown_export/agent-metadata content. - Fix stale `skillopt.toml` -> `optimize.toml` provenance filename and the evals-core -> fastskill-evals crate name in README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Aligns all user-facing documentation with the CLI command-surface changes shipped in #183 (PR #185) and #184 (PR #186). No code changes — docs only.
What changed
syncremoved everywhere. Documents that modern agents (Claude Code, Cursor, …) read installed skills directly from the skills directory — no metadata-file sync step. Updatedindex.mdx,welcome.mdx,cheatsheet.mdx,reindex-command.mdx, and both integration pages.show→read. Replacedfastskill showwithfastskill read --meta/fastskill read --tree(andfastskill listfor enumeration) incheatsheet.mdx,welcome.mdx,validation.mdx,manifest-system.mdx.doctor+ conditional reindex documented. Addedfastskill doctorto the cheatsheet/index/welcome and noted thatreindexis skipped (not an error) when no embedding provider is configured.resolvereplacement. Addedsearch --local --paths/--contentrows to the cheatsheet (the machine-readable path that replacedresolve).claude-code-integration.mdxandcursor-integration.mdxare reframed around direct discovery + MCP registration; dropped the fictionalmarkdown_export/ agent-metadata-file content and "Future Enhancements" filler.skillopt.toml→optimize.toml(provenance filename; matches code, with back-compat note) andcrates/evals-core→crates/fastskill-evalsin README.Verification
fastskill sync/fastskill show/fastskill resolve/fastskill disable— only intentional "removed / replaced by" notes remain.🤖 Generated with Claude Code