coilysiren/cli-web-docs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Plan: adopt urfave/cli release + docs shells #1

New issue
Closed
opened 2026-05-23 20:53:55 +00:00 by coilysiren · 0 comments
coilysiren commented 2026-05-23 20:53:55 +00:00
Owner
Copy link

Originally filed by @coilysiren on 2026-05-13T12:17:46Z - https://github.com/coilysiren/cli-web-docs/issues/14

Goal: the four cli-* repos converge on urfave/cli's repo-shell conventions so the family reads as part of the urfave ecosystem rather than four bespoke projects.

In scope (shells, not behavior):

  • CODE_OF_CONDUCT.md mirroring urfave's
  • Makefile target naming matching urfave (test / lint / vet / build / coverage)
  • .gitignore matching urfave's Go template
  • staticcheck.conf if/when we use staticcheck
  • mkdocs-shaped docs/ tree (deferred until cli-web-docs is hosting itself, which is the natural moment)
  • godoc-current.txt as a tracked file (urfave regenerates and diffs it; surfaces API drift across releases)
  • Semantic version tags (v0.x → v1.0.0 when the API firms up)
  • Release notes per tag in GitHub Releases
  • README badges: ci status, godoc, go.mod version, license

Out of scope:

  • Auto-bump of cli/v3 dep. urfave/cli is stable enough that an
    automated bumper would mostly be noise; pin and bump manually.
  • mkdocs.yml itself until cli-web-docs is actually hosting docs at
    cli.urfave.org-equivalent for these repos.
  • Conference-talk-style CONTRIBUTING.md - the cli-* family is solo
    for now.

Cross-link: all four repos carry this same issue so the convergence
work is visible across the family.

_Originally filed by @coilysiren on 2026-05-13T12:17:46Z - [https://github.com/coilysiren/cli-web-docs/issues/14](https://github.com/coilysiren/cli-web-docs/issues/14)_ Goal: the four cli-* repos converge on urfave/cli's repo-shell conventions so the family reads as part of the urfave ecosystem rather than four bespoke projects. In scope (shells, not behavior): - CODE_OF_CONDUCT.md mirroring urfave's - Makefile target naming matching urfave (test / lint / vet / build / coverage) - .gitignore matching urfave's Go template - staticcheck.conf if/when we use staticcheck - mkdocs-shaped docs/ tree (deferred until cli-web-docs is hosting itself, which is the natural moment) - godoc-current.txt as a tracked file (urfave regenerates and diffs it; surfaces API drift across releases) - Semantic version tags (v0.x → v1.0.0 when the API firms up) - Release notes per tag in GitHub Releases - README badges: ci status, godoc, go.mod version, license Out of scope: - Auto-bump of cli/v3 dep. urfave/cli is stable enough that an automated bumper would mostly be noise; pin and bump manually. - mkdocs.yml itself until cli-web-docs is actually hosting docs at cli.urfave.org-equivalent for these repos. - Conference-talk-style CONTRIBUTING.md - the cli-* family is solo for now. Cross-link: all four repos carry this same issue so the convergence work is visible across the family.
coilysiren 2026-05-30 05:44:16 +00:00
  • closed this issue
  • added the
    icebox
         label
Commenting is not possible because the repository is archived.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
burndown-2026-06
Backlog burndown June 2026

  
icebox
Closed in the 2026-05-29 backlog burn-down; reopen if it becomes real

  
P0
now / blocking / urgent

  
P1
next / important

  
P2
backlog / will do

  
P3
someday / low

  
P4
P4

No labels
burndown-2026-06
icebox
P0
P1
P2
P3
P4
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
coilysiren/cli-web-docs#1
No description provided.