docs: backfill package documentation#196
Open
iamlasse wants to merge 2 commits into
Open
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
Add canonical doc.go package documentation for 15 internal packages, grounded in each package's actual source: purpose, key exported types, and how it fits into the orchestrator. Removes the prior terse one/two-line package comments from the original source files so each package has a single canonical package doc rendered by godoc/pkg.go.dev. Also wires the existing-but-orphaned website/docs/troubleshooting.md into website/sidebars.js under Reference. 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
1 participant
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
Adds idiomatic Go package documentation (
doc.gowith// Package ...comments) for 15 internal packages, and de-orphans an existing docs page.Package docs
Each
doc.gois grounded in the package's actual source — purpose, key exported types, and how the package fits into the orchestrator — rather than boilerplate. The prior terse one/two-line package comments were removed from the original source files so each package now has a single canonical package doc (the one godoc/pkg.go.dev renders).Packages covered:
agents,budget,calibrator,db,integrations,logging,orchestrator,projects,providers,scheduler,setup,state,stats,tmux,trends.Sidebar fix
Wires the existing-but-orphaned
website/docs/troubleshooting.mdintowebsite/sidebars.jsunder Reference so the page is reachable from the docs nav.Verification
Comment-only changes; build/vet is the verification gate.
Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift