Document editor setup, mise install, and Agentic Skill#732
Document editor setup, mise install, and Agentic Skill#732dahlia merged 3 commits intofedify-dev:mainfrom
Conversation
The installation page covered fedify init and manual JSR/npm installation only. Three new sections at the bottom close common post-install questions: - "Editor setup" shows the .vscode/ files fedify init writes for Deno and Node.js/Bun projects, points Zed users at the snippets they need to add by hand, and notes Oxc as an alternative to Biome and ESLint. - "Linting" is a short bridge that mentions the @fedify/lint plugin is wired up automatically and links to the Linting chapter for the rest. - "Agentic skill" documents the SKILL.md bundled inside @fedify/fedify starting with Fedify 2.2.0: skills-npm + a prepare script for Node.js/Bun, manual download via curl for Deno (with a forward pointer to the Claude Code plugin marketplace work). fedify-dev#711 fedify-dev#712 fedify-dev#489 Assisted-by: Claude Code:claude-opus-4-7
The asciinema demo video for the fedify init command was outdated due to recent UI changes. This commit updates the documentation to link to the newly recorded video (ID: 979416). Assisted-by: Gemini CLI:gemini-2.0-flash-exp
Users can now install the fedify CLI tool using mise by running `mise use -g github:fedify-dev/fedify`. This commit adds the corresponding instructions to the CLI documentation. Assisted-by: Gemini CLI:gemini-2.0-flash-exp
|
@codex review |
📝 WalkthroughWalkthroughDocumentation updates across CLI and installation guides: adds Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Code Review
This pull request enhances the documentation by adding a guide for installing the CLI with mise, detailed editor configuration instructions for VS Code and Zed, and a new section on integrating Fedify's agentic skills with AI assistants. The review feedback suggests consistent formatting for npm package names using italics instead of backticks and recommends removing the outdated reference to OpenAI Codex.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
|
Pre-release has been published for this pull request: Packages
DocumentationThe docs for this pull request have been published: |
Context: #731 (comment).
Read it at https://pr-732.fedify.pages.dev/install#editor-setup.
This PR rounds out the Installation and CLI toolchain docs with three improvements:
skills-npmtogether with apreparescript; the Deno side downloads viacurland includes a forward pointer to Claude Code plugin for developing with Fedify #489 for the future Claude Code plugin marketplace work.fedifyCLI can be installed withmise use -g github:fedify-dev/fedifyalongside the existing Deno and standalone-executable paths.fedify initwizard; the previous recording (671658) had drifted from the current UI.The Agentic Skill section is a documentation follow-up to #711/#712: the skill itself ships inside the
@fedify/fedifypackage, but until now neither that PR nor the existing docs explained how end users should expose it to their agent's skills directory. Recording the install paths now also makes the upcoming Fedify 2.2.0 release notes easier to point at.