docs: backfill missing package and exported-symbol documentation#187
Open
iamlasse wants to merge 2 commits into
Open
docs: backfill missing package and exported-symbol documentation#187iamlasse 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
Add godoc comments for previously undocumented exported constant blocks (integrations HintType, orchestrator EventType/TaskStatus, security AuditEventType/OperationType, setup Preset, tasks CostTier/RiskLevel), fix malformed doc comments (logging Error, security OperationType), add a package doc for the provider-calibration command, normalize agent/provider file headers so they are not treated as package docs, and document the package layout in the README. 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
Documentation-only change (no behavior changes). Backfills missing Go-idiomatic
godoc so every exported symbol and package renders correctly under `go doc`.
What was documented
`internal/agents` and `internal/providers`) reworded so they are no longer
misinterpreted as package docs (the canonical `Package ...` doc already lives
in `agent.go`/`provider.go`).
responsibility and pointing at `go doc`.
Validation
Notes
A pre-existing stale branch `docs/backfill-missing-docs` on the fork holds a
different, unmerged prior attempt (CONTRIBUTING.md, ARCHITECTURE.md, CLI
reference). This PR was pushed under a distinct branch name to avoid
overwriting that work.
Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift