docs: backfill CLI reference, architecture overview, and package doc - #227
Open
iamlasse wants to merge 2 commits into
Open
docs: backfill CLI reference, architecture overview, and package doc#227iamlasse wants to merge 2 commits into
iamlasse wants to merge 2 commits into
Conversation
Add internal/commits with pure Normalize/validate functions enforcing the project's Conventional Commits rules (known type set, lowercase type, lowercase subject, 72-char subject limit, whitespace trimming, and 72-column body wrapping). Wire it into the CLI as 'nightshift commit normalize' (positional, --file, and stdin sources; --check to validate only), ship a commit-msg git hook under scripts/, and document the format and installation in docs/commit-messages.md. Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
- Expand website/docs/cli-reference.md with sections for commit (normalize), busfactor, config (get/set/validate), init, doctor, daemon (start/stop/status), install/uninstall, logs, report, status, stats, and setup, captured from each command's help text - Add docs/architecture.md mapping the Go packages and the run flow; link it from README.md - Add the missing package-level doc comment to cmd/provider-calibration/main.go Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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
2 participants
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.
Summary
Backfills three documentation gaps found by auditing the repo:
website/docs/cli-reference.mddocumented onlyrun,preview,task, andbudgetin detail. Added sections forcommit normalize,busfactor,config(get/set/validate),init,doctor,daemon(start/stop/status),install/uninstall,logs,report,status,stats, andsetup, with flags captured from each command's actual--helpoutput, plus expandedbudget snapshot/history/calibratedetail.docs/architecture.md: a package map (command layer, core runtime, budget/usage data, persistence, analysis) and a walkthrough of how a run flows through them, linking todocs/guides/run-lifecycle.md. Linked from the README's Development section.cmd/provider-calibrationwas the only Go package missing a// Packagecomment; added one linking todocs/guides/provider-calibration.md. A repo-wide sweep confirmed all other exported declarations already have doc comments.Verification
go build ./...andgo vet ./...pass--helpoutputNightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift