docs: backfill missing project documentation#181
Open
iamlasse wants to merge 1 commit into
Open
Conversation
Add CONTRIBUTING.md (dev loop, Makefile targets, pre-commit hook, branch/PR workflow, commit trailer convention) and ARCHITECTURE.md (module overview, cmd layer, internal packages grouped by responsibility, with inferred relationships flagged as assumptions). Add the missing package doc comment to cmd/provider-calibration, and backfill website/docs/cli-reference.md with the missing config/init/report/install/uninstall/busfactor commands plus daemon and config subcommand details. 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
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 the standard project-level documentation that was missing from the repo. The Go code itself is already fully documented (all exported decls have doc comments; only 1 of 24 packages lacked a
// Packagedoc), so this PR targets the project artifacts rather than code comments.Changes
CONTRIBUTING.md(new) — prerequisites, the dev loop viamaketargets (build,test,test-race,coverage,lint), the pre-commit hook (make install-hooks→ gofmt/go vet/go build, bypass via--no-verify), branch + PR workflow, and the required commit-trailer convention (Nightshift-Task/Nightshift-Ref). Grounded in the existingMakefile,scripts/pre-commit.sh, and the README Development section.ARCHITECTURE.md(new) — module overview, thecmd/layer, and theinternal/packages grouped by responsibility (config/state/db, agents/providers/integrations, tasks/scheduler/orchestrator, budget/calibration feedback loop, security, observability, analysis, projects/setup). Package descriptions are taken from each package's own doc comment; dependency edges are verified from imports. Referencesdocs/guides/run-lifecycle.mdfor the runtime flow rather than duplicating it. Inferred relationships are explicitly flagged as assumptions.cmd/provider-calibration/main.go— added the missing// Command provider-calibrationpackage doc (the only package of 24 lacking one), describing it as the standalone diagnostic tool that aggregates Codex/Claude session metrics to suggest a budget-calibration multiplier.website/docs/cli-reference.md— audited against the actual cobra command tree and backfilled genuine gaps: added the missing top-level commands (config,init,report,install,uninstall,busfactor) to the command table, and added newConfiguration CommandsandDaemon Commandssections documenting theconfig get/set/validateanddaemon start/stop/statussubcommands and their flags.Verification
gofmt -l .→ emptygo vet ./...→ cleango build ./...→ cleango test ./...→ all passgo doc ./cmd/provider-calibration→ new package doc rendersNotes
internal/sandboxorinternal/uipackage exists; references to a sandbox layer were treated as non-existent (not fabricated).ARCHITECTURE.mdare marked as assumptions.Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift