Skip to content

docs: document fmt and --mirror on the site - #114

Merged
jccguimaraes merged 1 commit into
mainfrom
docs/site-fmt-mirror
Oct 30, 2026
Merged

jccguimaraes merged 1 commit into
mainfrom
docs/site-fmt-mirror

Conversation

@jccguimaraes

Copy link
Copy Markdown
Contributor

The site was written before 1.3.0 and never caught up. Three things shipped without a page: fmt (1.4.0), --mirror and --check (1.3.0).

Changes

index.html — a cinzel fmt row in the commands table.

docs.html — a fmt section before init, with a nav entry. Covers the no-flag default (the directories in .cinzelrc.yaml, or ./cinzel), --check for CI, and that a run finding no HCL fails rather than reporting a clean check, so a wrong path cannot pass silently.

--mirror goes in the shared flags table, plus a subsection under unparse: what the layout looks like, that path still decides where a file goes on the way back, that a mirrored tree needs --recursive, and why workflows stay at the top of the output directory.

Wording follows README.md so the two do not drift.

Checks

  • Anchors resolve on both pages, no broken href="#..."
  • Tag nesting balanced on both pages
  • mise run drift — 4 checked, 0 differ
  • mise run lint — clean

Docs only. No Go touched.

The site was written before 1.3.0 and never caught up: fmt, --mirror
and --check shipped without a page.

fmt gets a section of its own, covering the no-flag default, --check
for CI, and that a run finding no HCL fails rather than reporting a
clean check. --mirror goes in the shared flags table and gets a
subsection under unparse explaining why workflows stay flat under it.
@github-actions

Copy link
Copy Markdown
Go test coverage: 78.6% for commit ff8fc4e
⚠️ 1 of 21 packages have zero coverage.
  • github.com/yldio/cinzel/internal/test
View coverage for all packages
# Package Name                                     | Coverage
+ github.com/yldio/cinzel                          |    57.1%
+ github.com/yldio/cinzel/internal/ai              |    67.7%
+ github.com/yldio/cinzel/internal/cinzelerror     |    82.8%
+ github.com/yldio/cinzel/internal/command         |    70.5%
+ github.com/yldio/cinzel/internal/fsutil          |    81.3%
+ github.com/yldio/cinzel/internal/hclcomment      |   100.0%
+ github.com/yldio/cinzel/internal/hclparser       |    78.1%
+ github.com/yldio/cinzel/internal/maputil         |    93.3%
+ github.com/yldio/cinzel/internal/naming          |    92.9%
+ github.com/yldio/cinzel/internal/pin             |    65.3%
- github.com/yldio/cinzel/internal/test            |     0.0%
+ github.com/yldio/cinzel/internal/unescape        |    93.8%
+ github.com/yldio/cinzel/internal/yamldoc         |    80.0%
+ github.com/yldio/cinzel/internal/yamlwriter      |    83.6%
+ github.com/yldio/cinzel/provider                 |    52.7%
+ github.com/yldio/cinzel/provider/github          |    82.7%
+ github.com/yldio/cinzel/provider/github/action   |    57.8%
+ github.com/yldio/cinzel/provider/github/job      |    95.0%
+ github.com/yldio/cinzel/provider/github/step     |    77.6%
+ github.com/yldio/cinzel/provider/github/workflow |    86.3%
+ github.com/yldio/cinzel/provider/gitlab          |    80.7%

@jccguimaraes
jccguimaraes merged commit 1f717e7 into main Oct 30, 2026
5 checks passed
@jccguimaraes
jccguimaraes deleted the docs/site-fmt-mirror branch October 30, 2026 14:09
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.

1 participant