Skip to content

docs: migrate cross-repo standards from ai-assistant-instructions#32

Merged
JacobPEvans merged 2 commits into
mainfrom
feature/migrate-agentsmd-rules-to-docs
May 24, 2026
Merged

docs: migrate cross-repo standards from ai-assistant-instructions#32
JacobPEvans merged 2 commits into
mainfrom
feature/migrate-agentsmd-rules-to-docs

Conversation

@JacobPEvans
Copy link
Copy Markdown
Owner

Summary

  • Move 10 of 14 rule files (~71%) from JacobPEvans/ai-assistant-instructions/agentsmd/rules/ into the public docs site. The flaky agent-only loading mechanism is the wrong home for standards humans need to read.
  • Adds a new top-level Conventions nav group (overview + commit-conventions + no-scripts + diagramming) and four detail pages under existing Infrastructure / Nix / Security groups.
  • Folds the open ai-assistant-instructions PR #654 (on-prem self-hosted runner exception) into the new infrastructure/cicd/policy.mdx page so it lands as part of the migration.

What moved

Source rule Destination
ci-cd-policy.md + PR #654 infrastructure/cicd/policy.mdx
git-signing.md infrastructure/cicd/git-signing.mdx
terraform-checks-placement.md infrastructure/terraform-check-placement.mdx
nix-package-placement.md nix/package-placement.mdx
no-scripts.md conventions/no-scripts.mdx
soul.md (commit/PR portion) conventions/commit-conventions.mdx
secrets-policy.md absorbed into security/golden-laws.mdx + security/overview.mdx
config-secrets.md security/scrubbed-values.mdx
diagramming.md conventions/diagramming.mdx (links to this repo's AGENTS.md for the canonical Mermaid style guide)
bifrost-routing.md extended architecture/ai-pipeline.mdx

Stays in agentsmd/rules/ because it is AI-runtime only:
tool-use.md, skill-execution-integrity.md, nix-tool-policy.md, residual soul.md (voice/autonomy), infra/ subdir.

Voice adjustments per page

The rule files were written in agent-instruction voice ("you MUST", banned/allowed tables). On the docs site they're reframed in active second-person voice with pull-quote openers, Mintlify CardGroup "where to go next" sections, and tier: frontmatter matching the existing site convention. Substance — runner-label catalogs, the four-tier search, the placement matrix, the scrubbed-values table — is preserved verbatim.

Verification

  • jq empty docs.json passes
  • Canonical Mermaid theme directive count remains 1 (unchanged across the repo)
  • 35 internal links audited; all resolve to existing or newly-created pages
  • No real IPs, account IDs, or tokens introduced (scrubbed-values placeholders 192.168.0.*, 2001:db8::*, example.com, <token> only)
  • No new private-repo references introduced (gh repo view confirms every JacobPEvans/* reference in the diff is PUBLIC; the pre-existing terraform-aws link in infrastructure/cicd/terraform-runs-on.mdx is unchanged by this PR and out of scope here)

Test plan

  • mint dev and click every new page (Conventions x4, CI/CD policy, CI/CD git-signing, terraform-check-placement, nix/package-placement, security/scrubbed-values)
  • Verify the new Conventions group appears in the sidebar between AI Development and Observability
  • Verify Infrastructure -> CI/CD subgroup now lists: overview, policy, git-signing, terraform-runs-on
  • Verify mermaid blocks (none added in this PR, but ai-pipeline got an edit — confirm the existing diagram still renders with the handDrawn theme)
  • mint broken-links
  • Spot-check one CardGroup destination per new page to confirm the Mintlify Card components render

Follow-up (separate PR in ai-assistant-instructions)

Once this lands:

  1. Delete the 10 migrated rule files (or migrated portions of soul.md)
  2. Update any remaining cross-references in the surviving rules to point at https://docs.jacobpevans.com/...
  3. Close PR #654 in favor of this migration
  4. Audit agentsmd/rules/infra/ subdir for references to deleted files

🤖 Generated with Claude Code

Move 10 of 14 rule files (~71%) from JacobPEvans/ai-assistant-instructions
agentsmd/rules/ into the public docs site. The flaky agent-only loading
mechanism is the wrong home for standards humans need to read; this PR
puts CI/CD policy, git signing, Terraform check placement, Nix package
placement, scrubbed-values, no-scripts, commit conventions, diagramming,
and Bifrost routing into docs.jacobpevans.com where they belong.

New pages:
- infrastructure/cicd/policy.mdx (folds in PR #654's on-prem runner rules)
- infrastructure/cicd/git-signing.mdx
- infrastructure/terraform-check-placement.mdx
- nix/package-placement.mdx
- security/scrubbed-values.mdx
- conventions/ group: overview, commit-conventions, no-scripts, diagramming

Existing pages absorb the rest:
- security/golden-laws.mdx: law 1, 3, 8, 15 enforcement links repointed
- security/overview.mdx: scrubbed-values card added
- infrastructure/cicd/overview.mdx: links to policy + git-signing + tf-checks
- architecture/ai-pipeline.mdx: Bifrost/PAL local-AI-gateway section added
- ai-development/ai-assistant-instructions.mdx: scope-narrows what
  ai-assistant-instructions owns (AI-runtime only); points to Conventions

Verification:
- jq empty docs.json passes
- Canonical Mermaid theme directive count: 1 (unchanged)
- 35 internal links all resolve to existing or new pages
- No real IPs / account IDs / tokens introduced
- No new private-repo references introduced

Follow-up in JacobPEvans/ai-assistant-instructions (separate PR):
- Delete the 10 migrated rule files
- Update remaining cross-references to point at docs.jacobpevans.com
- Close PR #654 in favor of this migration

Assisted-by: Claude <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
jacobpevans 🟢 Ready View Preview May 24, 2026, 8:25 PM

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a comprehensive suite of documentation pages defining cross-repo standards for commit conventions, Mermaid diagramming, script placement, and CI/CD policies. It also establishes security guidelines for Git signing and the use of scrubbed values for sensitive data placeholders. The navigation structure has been updated to integrate these new sections. Review feedback focuses on maintaining consistency between the order of cross-reference cards and the site's navigation hierarchy defined in docs.json, as well as ensuring macOS security command examples include absolute keychain paths to prevent lookup failures.

Comment thread security/scrubbed-values.mdx Outdated
Comment thread conventions/no-scripts.mdx
Comment thread conventions/diagramming.mdx
Comment thread infrastructure/cicd/policy.mdx
Comment thread infrastructure/cicd/git-signing.mdx
Comment thread conventions/commit-conventions.mdx
Comment thread infrastructure/cicd/overview.mdx
Non-default keychains (ai-secrets, automation, elevate-access) require
the absolute path as the final positional argument; without it, the
command searches only the default login keychain and the lookup fails.

Assisted-by: Claude <noreply@anthropic.com>
JacobPEvans added a commit to JacobPEvans/ai-assistant-instructions that referenced this pull request May 24, 2026
)

The agentsmd/rules/ folder accreted human-readable cross-repo standards
that should not be locked inside an agent-only loading mechanism.
JacobPEvans/docs#32 moves them to the public docs site; this PR removes
the source files (and trims soul.md to AI-specific voice/autonomy only).

Deleted (full content now on docs.jacobpevans.com):
- ci-cd-policy.md           -> /infrastructure/cicd/policy
- git-signing.md            -> /infrastructure/cicd/git-signing
- terraform-checks-placement.md -> /infrastructure/terraform-check-placement
- nix-package-placement.md  -> /nix/package-placement
- no-scripts.md             -> /conventions/no-scripts
- diagramming.md            -> /conventions/diagramming
- secrets-policy.md         -> absorbed into /security/golden-laws + /security/overview
- config-secrets.md         -> /security/scrubbed-values
- bifrost-routing.md        -> absorbed into /architecture/ai-pipeline

Edited:
- soul.md: dropped commit/PR subject conventions (no-emoji, Conventional
  Commits) - now in /conventions/commit-conventions. Voice and autonomy
  bullets stay because they're AI-runtime behavior, not commit shape.
- AGENTS.md: 'no-scripts.md' and 'diagramming.md' references repointed
  to docs URLs.
- docs/diagrams.md: rule-file lists in the architecture and lifecycle
  diagrams updated to reflect the surviving four rules (tool-use, soul,
  skill-execution-integrity, nix-tool-policy).

The Nix loader (`discoverMarkdownFiles` in
JacobPEvans/nix-ai/modules/claude-config.nix) globs all .md files in
agentsmd/rules/, so deleted files just stop loading - no manifest
to update.

Refs: JacobPEvans/docs#32
Closes #654 (folded into JacobPEvans/docs#32's policy.mdx)

Assisted-by: Claude <noreply@anthropic.com>
@JacobPEvans JacobPEvans merged commit bb9d3dc into main May 24, 2026
6 checks passed
@JacobPEvans JacobPEvans deleted the feature/migrate-agentsmd-rules-to-docs branch May 24, 2026 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant