Skip to content

Add generated man pages for fnm and subcommands - #1526

Open
Schniz wants to merge 2 commits into
masterfrom
schniz/1426-man-pages
Open

Add generated man pages for fnm and subcommands#1526
Schniz wants to merge 2 commits into
masterfrom
schniz/1426-man-pages

Conversation

@Schniz

@Schniz Schniz commented Mar 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • add clap_mangen-backed manpage generation via a hidden fnm man [subcommand...] command
  • generate and commit man/*.1 files for fnm and each subcommand, and document usage/install in README
  • wire generation into release prep and CI checks so manpages stay in sync with CLI changes
  • add a patch changeset for shipping the new manpage workflow

Testing

  • cargo fmt
  • cargo test
  • pnpm run generate-command-docs --check --binary-path=./target/debug/fnm
  • pnpm run generate-man-page --check --binary-path=./target/debug/fnm

Closes #1426

@vercel

vercel Bot commented Mar 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
fnm Ready Ready Preview, Comment Mar 9, 2026 10:07pm

@changeset-bot

changeset-bot Bot commented Mar 9, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: ee0d5d5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
fnm Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Add clap_mangen-based man page generation for fnm and subcommands, and keep generated files checked in and validated in CI/release prep so offline docs stay in sync with the CLI.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Man page

1 participant