Skip to content

Fill the man page version at build time and refresh docs - #80

Merged
mapitman merged 1 commit into
mainfrom
chore/docs-manpage-versioning
Oct 14, 2026
Merged

mapitman merged 1 commit into
mainfrom
chore/docs-manpage-versioning

Conversation

@mapitman

Copy link
Copy Markdown
Owner
  • mdview.1.md uses an @VERSION@ placeholder instead of the hardcoded 1.4.0.
  • just manpage [version] replaces the placeholder. The default is git describe --tags --always. The goreleaser hook passes {{ .Version }}, so the man page gets the release version (checked with goreleaser build --snapshot: Version 1.9.0-SNAPSHOT-ec5f430).
  • The SYNOPSIS now lists -o and -b. Option spelling is consistent, and the man page describes flag placement and temp file cleanup.
  • CLAUDE.md: removes the mise.toml reference, documents the placeholder rule, and records how to find and update the vendored Mermaid version. The stale "no test files" statement was fixed in Embed images by walking the AST instead of rewriting source #74.

.github/copilot-instructions.md is also out of date (Go 1.21.1, Make, the old markdown library). That is not part of this issue.

Closes #71

The man page header had a hardcoded Version 1.4.0. Use an @Version@ placeholder that just manpage replaces, defaulting to the latest git tag. goreleaser passes its own version to the hook, so release builds get the release version. The generated mdview.1 stays untracked.

Add the missing -o and -b options to the SYNOPSIS, make the option spelling consistent, and describe flag placement and temp file cleanup.

In CLAUDE.md, drop the mise.toml reference (the file is not tracked), document the placeholder rule, and record how to find and update the vendored mermaid.min.js version.

Closes #71
@mapitman
mapitman merged commit bf17ba2 into main Oct 14, 2026
2 checks passed
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.

Refresh docs and man page, with build-time versioning

1 participant