Repository navigation
docs: document fmt and --mirror on the site - #114
Merged
Merged
Conversation
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.
Go test coverage: 78.6% for commit ff8fc4e
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The site was written before 1.3.0 and never caught up. Three things shipped without a page:
fmt(1.4.0),--mirrorand--check(1.3.0).Changes
index.html — a
cinzel fmtrow in the commands table.docs.html — a
fmtsection beforeinit, with a nav entry. Covers the no-flag default (the directories in.cinzelrc.yaml, or./cinzel),--checkfor CI, and that a run finding no HCL fails rather than reporting a clean check, so a wrong path cannot pass silently.--mirrorgoes in the shared flags table, plus a subsection underunparse: what the layout looks like, thatpathstill 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.mdso the two do not drift.Checks
href="#..."mise run drift— 4 checked, 0 differmise run lint— cleanDocs only. No Go touched.