docs(conventions): pre-commit architecture page#48
Open
JacobPEvans-personal wants to merge 2 commits into
Open
docs(conventions): pre-commit architecture page#48JacobPEvans-personal wants to merge 2 commits into
JacobPEvans-personal wants to merge 2 commits into
Conversation
Document the shared pre-commit architecture as a public-facing
convention page mirroring the auto-loaded agentsmd rule.
Adds conventions/pre-commit.mdx and the corresponding entry to
docs.json's Conventions group nav.
Covers:
- Canonical homes table (Nix-path nix-devenv, non-Nix-path
dryvist/.github precommit/, lint configs in dryvist/.github)
- Six profiles (base, nix, markdown, terraform, ansible, python)
- Consumer patterns for Nix and non-Nix paths with full snippets
- The `nix flake init -t #with-hooks` scaffold
- Why one canonical home per artifact (single update propagates,
drift dies, one-line onboarding)
- What stays per-repo (checkov, bandit, detect-secrets, AWS/GCP/
Azure tflint plugins) and why
- Known limitations matching the agentsmd rule
Mirrors:
https://github.com/dryvist/ai-assistant-instructions/blob/main/agentsmd/rules/pre-commit.md
Refs: dryvist/nix-devenv#34, #35, dryvist/.github#12, dryvist/terraform-runs-on#80, dryvist/ai-assistant-instructions#661
Assisted-by: Claude <noreply@anthropic.com>
Forgot to stage the nav update in the previous commit; the page exists but wasn't discoverable through the sidebar. Assisted-by: Claude <noreply@anthropic.com>
3 tasks
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
Public-facing convention page mirroring the auto-loaded
agentsmd/rules/pre-commit.mdfromdryvist/ai-assistant-instructions#661. The two stay in sync per the repo-boundaries convention (descriptive docs on the site, agent directives inAGENTS.md-loaded rules).What's added
conventions/pre-commit.mdx— full architecture overview with consumer patterns, profile list, why/what-stays-per-repo, and known limitationsdocs.json— addsconventions/pre-committo the Conventions group navPairs with
dryvist/nix-devenv#34, #35—flakeModules.{base,terraform,ansible,python,nix,markdown}+lib/fetch-shared-configs.nix+templates/with-hooks/dryvist/.github#12—precommit/configs/+precommit/templates/dryvist/ai-assistant-instructions#661— auto-loaded agent ruledryvist/terraform-runs-on#80— Phase 2 trial migrationTest plan
mint devshows the page rendered under Conventions in the navAssisted-by: Claude noreply@anthropic.com