docs: add per-module pages, README table, and small src cleanup#21
Merged
Conversation
- docs/modules/{mkdocs,kind,pre-commit,k8s}.md: task/variable tables per module with override examples
- mkdocs.yml: nav with Overview + Modules group
- README.md: replace intro bullet list with Module/Tasks/Variables table
- src/taskfile-include-k8s.yaml: `| true` -> `|| true` on kubectl create namespace; align cmds indentation
- src/taskfile-include-mkdocs.yaml: drop stray `---` doc separator for consistency
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rephrase four Vale suggestions surfaced by Microsoft.Passive, Microsoft.ComplexWords, and Microsoft.Vocab: - pre-commit module page: "against every file" → "over every file" - PR template: "being added" → "you are adding" - bug/feature/PR templates: "prioritize" → "rank" Repo-level errors and remaining suggestions on H1 identifiers (taskfiles, k8s, kind, pre-commit) are upstream-vocab candidates for nolte/vale-style and intentionally left in place. Title-cased section headings in .github/ templates follow the HashiCorp issue-template convention and are also left as-is. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Audit against spec/project/project-structure/ surfaced seven items: - Add release-publish.yml (mandatory per branching-model spec) pinned to nolte/gh-plumbing@v1.1.12, on: workflow_dispatch only. - Pin automerge.yaml and spelling.yaml from @develop to @v1.1.12 so release-pipeline behaviour stays reproducible (AC §135). - Expose `task lint` and `task docs` wrappers in Taskfile.yml (SHOULD per spec §CI and automation). No `test` target — repo ships YAML includes only, no runtime code. - Scaffold spec/ and tests/ with .gitkeep stubs. - Add MIT LICENSE. Open: tests/ stays empty per spec Open Question §7 (YAML-only repo without runtime code); GitHub-App installation could not be verified automatically because the local token lacks the required scope. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Stop the three reviewdog annotations on PR #21 (Microsoft.Headings on k8s, kind, pre-commit) and the two repo-wide Vale.Spelling errors on "taskfiles" by accepting them through a local vocabulary: - .github/styles/config/vocabularies/taskfiles/accept.txt with k8s, kind, pre-commit, taskfiles - .vale.ini: Vocab = taskfiles - .gitignore: allow .github/styles/config/ to be tracked while keeping the rest of the synced styles excluded Result: vale --no-exit . goes from 2 errors + 19 suggestions to 0 errors + 14 suggestions; the remaining suggestions are HashiCorp- style Title Case headings in .github/ templates and the "are interested" community-note footer, both intentionally untouched. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The previous exception (`!.github/styles/config/**`) was too broad and would have started tracking vendored Vale vocabularies once they show up under .github/styles/config/vocabularies/ — for example the `technical` set that `vale sync` pulls from nolte-styles. Restrict the exception to .github/styles/config/vocabularies/taskfiles/ so only the repo-local vocab is tracked. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 19, 2026
Closed
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
Expand the documentation surface for the reusable Taskfile includes: replace
the flat README bullet list with a module table, add per-module pages under
docs/modules/, wire them into the mkdocs navigation, and fix two small
correctness issues in the k8s and mkdocs source includes.
Changes
tasks and key tunable variables.
pre-commit, and k8s, each with a Tasks / Variables / Example layout.
nav:section to mkdocs.yml exposing an Overview plus a Modulesgroup, so the new pages are reachable from the rendered site.
kubectl create namespace argocd | true→|| trueinsrc/taskfile-include-k8s.yaml so a pre-existing namespace no longer aborts
the bootstrap.
bootstrap.cmdsin the same file.---) at the top ofsrc/taskfile-include-mkdocs.yaml.
Linked issues
None
Testing
pre-commit run --all-files— all hooks pass (check-yaml, end-of-file-fixer,trailing-whitespace).
pages.
Risk / rollout notes
Low risk. Documentation-only on the consumer-visible surface; the two src/
changes are bug fixes (
| true→|| truemakes re-runs idempotent; removingthe stray
---has no semantic effect on Taskfile parsing).