Skip to content

Document editor setup, mise install, and Agentic Skill#732

Merged
dahlia merged 3 commits intofedify-dev:mainfrom
dahlia:docs/install/editors
Apr 28, 2026
Merged

Document editor setup, mise install, and Agentic Skill#732
dahlia merged 3 commits intofedify-dev:mainfrom
dahlia:docs/install/editors

Conversation

@dahlia
Copy link
Copy Markdown
Member

@dahlia dahlia commented Apr 27, 2026

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:

  • docs/install.md gains an Editor setup section (Visual Studio Code and Zed for both Deno and Node.js/Bun, with Oxc noted as an alternative to Biome and ESLint), a short Linting bridge that points readers at docs/manual/lint.md, and an Agentic Skill section explaining how to wire the bundled SKILL.md into Claude Code, Codex, OpenCode, and similar agents. The Node.js/Bun side uses skills-npm together with a prepare script; the Deno side downloads via curl and includes a forward pointer to Claude Code plugin for developing with Fedify #489 for the future Claude Code plugin marketplace work.
  • docs/cli.md gains a Using mise subsection so the fedify CLI can be installed with mise use -g github:fedify-dev/fedify alongside the existing Deno and standalone-executable paths.
  • Both docs/cli.md and docs/install.md now link to a freshly recorded asciinema demo for the fedify init wizard; 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/fedify package, 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.

dahlia added 3 commits April 27, 2026 21:09
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
@dahlia dahlia added this to the Fedify 2.2 milestone Apr 27, 2026
@dahlia dahlia self-assigned this Apr 27, 2026
@dahlia dahlia added type/documentation Improvements or additions to documentation component/cli CLI tools related labels Apr 27, 2026
@dahlia
Copy link
Copy Markdown
Member Author

dahlia commented Apr 27, 2026

@codex review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 27, 2026

📝 Walkthrough

Walkthrough

Documentation updates across CLI and installation guides: adds mise toolchain installation instructions, updates asciinema demo references, and expands the installation guide with new sections covering editor setup (VS Code, Zed), linting configuration, and the agentic skill feature.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/cli.md, docs/install.md
Added mise toolchain installation documentation and swapped asciinema demo IDs. Substantially expanded installation guide with editor setup guidance for VS Code and Zed, linting configuration details, and agentic skill introduction with workflow instructions for Node.js/Bun and Deno environments.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • sij411
  • 2chanhaeng
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes all three main documentation additions: editor setup, mise install path, and Agentic Skill coverage.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description clearly relates to the changeset, detailing three documentation improvements (Editor setup, Linting, Agentic Skill sections in docs/install.md; mise installation in docs/cli.md; and updated asciinema demo links).

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@issues-auto-labeler issues-auto-labeler Bot added component/build Build system and packaging component/integration Web framework integration labels Apr 27, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/install.md
Comment thread docs/install.md
Comment thread docs/install.md
Comment thread docs/install.md
Comment thread docs/install.md
@dahlia dahlia requested a review from 2chanhaeng April 27, 2026 12:28
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Copy Markdown
Contributor

Pre-release has been published for this pull request:

Packages

Package Version JSR npm
@fedify/fedify 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/cli 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/amqp 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/astro 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/cfworkers 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/create 2.2.0-pr.732.35+ffa09c82 npm
@fedify/debugger 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/denokv 2.2.0-pr.732.35+ffa09c82 JSR
@fedify/elysia 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/express 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/fastify 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/fixture 2.2.0-pr.732.35+ffa09c82 JSR
@fedify/fresh 2.2.0-pr.732.35+ffa09c82 JSR
@fedify/h3 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/hono 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/init 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/koa 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/lint 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/mysql 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/nestjs 2.2.0-pr.732.35+ffa09c82 npm
@fedify/next 2.2.0-pr.732.35+ffa09c82 npm
@fedify/nuxt 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/postgres 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/redis 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/relay 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/solidstart 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/sqlite 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/sveltekit 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/testing 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/vocab 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/vocab-runtime 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/vocab-tools 2.2.0-pr.732.35+ffa09c82 JSR npm
@fedify/webfinger 2.2.0-pr.732.35+ffa09c82 JSR npm

Documentation

The docs for this pull request have been published:

https://87a0b5ea.fedify.pages.dev

@dahlia dahlia removed component/integration Web framework integration component/build Build system and packaging labels Apr 27, 2026
@dahlia dahlia requested a review from sij411 April 28, 2026 03:16
@dahlia dahlia merged commit bb37b9e into fedify-dev:main Apr 28, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/cli CLI tools related type/documentation Improvements or additions to documentation

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

3 participants