-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
priority:highMust be in the next sprintMust be in the next sprintsize:sSmall — 1 to 4 hoursSmall — 1 to 4 hoursstatus:readyRefined and ready for sprint selectionRefined and ready for sprint selectiontype:docsDocumentation onlyDocumentation only
Milestone
Description
Description
Write a Unix manual page for sql-pipe using scdoc format and include it in release archives and package distributions.
Acceptance Criteria
-
docs/sql-pipe.1.scdwritten in scdoc format covering: NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, AUTHORS, SEE ALSO -
build.ziggeneratessql-pipe.1.gzwhenscdocis available (optional dependency) - Man page is included in the release workflow (added to release artifacts)
-
man sql-pipeworks after installation via Homebrew or AUR -
--helpoutput and man page are consistent
Notes
- scdoc is a lightweight man page authoring format: https://git.sr.ht/~sircmpwn/scdoc
- The
.1.gzartifact can be distributed standalone alongside binaries - Homebrew and AUR packages should install it to the correct
man1/path
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
priority:highMust be in the next sprintMust be in the next sprintsize:sSmall — 1 to 4 hoursSmall — 1 to 4 hoursstatus:readyRefined and ready for sprint selectionRefined and ready for sprint selectiontype:docsDocumentation onlyDocumentation only