docs: backfill CONTRIBUTING, architecture map, and docs-backfill guide#182
Open
iamlasse wants to merge 1 commit into
Open
docs: backfill CONTRIBUTING, architecture map, and docs-backfill guide#182iamlasse wants to merge 1 commit into
iamlasse wants to merge 1 commit into
Conversation
Add three genuinely-missing docs, grounded in the shipped codebase: - CONTRIBUTING.md: build/test/lint workflow, pre-commit hook, conventional-commit style, branch-from-main PR flow, the Nightshift-Task/Nightshift-Ref trailers, and doc-site preview. - docs/implemented/architecture.md: package map for the 21 internal and 2 cmd packages plus the CLI -> scheduler -> orchestrator -> provider -> PR flow. - docs/guides/docs-backfill.md: the docs-backfill task (category pr, cost Low, risk Low, 168h cooldown), what counts as missing docs, selection heuristics, and the safe-by-design PR output model. No Go files changed; no existing docs duplicated. 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
docs-backfilltask run — adds three genuinely missing documentation files, grounded in the shipped codebase (Go 1.24, 82 internal Go files,v0.3.x). No source files were changed.Added
CONTRIBUTING.md(new) — build/test/lint workflow (maketargets), themake install-hookspre-commit hook (gofmt +go vet+go build), conventional-commit style, the branch-from-main+ PR workflow, theNightshift-Task/Nightshift-Reftrailers, and how to preview the Docusaurus docs site.docs/implemented/architecture.md(new) — a package map covering all 21internal/*and the 2cmd/*packages (each grounded in its// Packagecomment), plus the CLI → config → scheduler → orchestrator → provider/agent → PR flow. Path validation is correctly attributed tointernal/security.ValidateProjectPath.docs/guides/docs-backfill.md(new) — documents thedocs-backfilltask itself: categorypr, cost Low, risk Low, 168h (7d) default cooldown, what counts as missing documentation, file-selection heuristics, interval overrides, and the safe-by-design "everything is a PR" output model.Deliberately not added (backfill scope)
README.md— the existing 291-line README is authoritative; re-adding it would conflict.doc.gofiles — every Go package already has a// Packagecomment in its source, so per-packagedoc.gofiles would create duplicate package comments.Validation
gofmt -l .clean;go vet ./...andgo build ./...pass (no Go changed).Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift