docs: move lead copy off governance wording to linting and guardrails#411
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (14)
📝 WalkthroughWalkthroughThis PR updates Archgate documentation and the roadmap to reposition the tool from a general governance layer to the standard for linting and guardrails enforcement. Changes are applied consistently across the roadmap, CLI reference, and concept pages in English, Norwegian, and Portuguese-BR. ChangesMessaging and positioning update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
Code Coverage
Full HTML report available in workflow artifacts. Per-directory breakdown
|
Deploying archgate-cli with
|
| Latest commit: |
249e81e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8fc04c4b.archgate-cli.pages.dev |
| Branch Preview URL: | https://docs-positioning-leads-clean.archgate-cli.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/src/content/docs/nb/reference/cli/init.mdx`:
- Around line 3-6: Update the sample output for the "archgate init" example:
find the occurrence of the string "Initialized Archgate governance in
/path/to/project" used in the init sample output and replace it with the new
positioning wording that matches the linting/rules-enforcement lead copy (i.e.,
the new message used elsewhere for archgate init). Ensure the example text in
the init.mdx localized content and any other localized init pages uses the
updated phrasing so the sample output and lead copy are consistent with the new
linting/rules-enforcement messaging.
In `@ROADMAP.md`:
- Line 9: Update the sentence that reads "Archgate becomes the standard linting
and guardrails for AI-assisted development." to a cleaner phrasing by replacing
"standard linting and guardrails" with either "standard for linting and
guardrails" or "standard linting and guardrails enforcement" so the line becomes
e.g. "Archgate becomes the standard for linting and guardrails for AI-assisted
development." Ensure the rest of the sentence remains unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 9b578ad4-74b9-457b-9cf2-1a83c7d44bd2
📒 Files selected for processing (14)
ROADMAP.mddocs/public/llms-full.txtdocs/src/content/docs/concepts/domains.mdxdocs/src/content/docs/examples/common-rule-patterns.mdxdocs/src/content/docs/nb/concepts/domains.mdxdocs/src/content/docs/nb/examples/common-rule-patterns.mdxdocs/src/content/docs/nb/reference/cli/index.mdxdocs/src/content/docs/nb/reference/cli/init.mdxdocs/src/content/docs/pt-br/concepts/domains.mdxdocs/src/content/docs/pt-br/examples/common-rule-patterns.mdxdocs/src/content/docs/pt-br/reference/cli/index.mdxdocs/src/content/docs/pt-br/reference/cli/init.mdxdocs/src/content/docs/reference/cli/index.mdxdocs/src/content/docs/reference/cli/init.mdx
Implements PR 1 of the positioning migration plan (linting-and-guardrails positioning adopted 2026-06-09). Rewrites lead-position copy (frontmatter descriptions, opening sentences, CLI command table rows, ROADMAP vision) in EN, pt-BR, and nb. Body-text supporting uses of governance are kept. Includes the build-regenerated docs/public/llms-full.txt. Signed-off-by: Rhuan Barreto <rhuan@barreto.work>
rhuanbarreto
force-pushed
the
docs/positioning-leads-cleanup
branch
from
1b20a08 to
249e81e
Compare
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
Implements PR 1 of the positioning migration plan (linting-and-guardrails positioning adopted 2026-06-09, canonical reference: internal
marketing/positioning.md). Moves lead-position copy (frontmatter descriptions, opening sentences, CLI command table rows, ROADMAP vision) off governance-first wording to the linting/guardrails vocabulary. Body-text supporting uses of governance are intentionally left alone.Changes
EN source:
docs/src/content/docs/reference/cli/init.mdx: description and opening sentence now read "Set up Archgate linting and rules enforcement in the current project."docs/src/content/docs/concepts/domains.mdx: description tail "...for targeted governance" -> "...to scope and enforce rules"docs/src/content/docs/examples/common-rule-patterns.mdx: description -> "Copy-paste rule patterns for enforcing common checks: ..."docs/src/content/docs/reference/cli/index.mdx: init row -> "Set up linting and rules enforcement"ROADMAP.mdVision: "standard governance layer" -> "standard linting and guardrails"Locales: the same four docs edits mirrored in
pt-br/andnb/.Build artifact:
docs/public/llms-full.txtregenerated by the docs build.Verification
docs/src/contentand root*.mdfor banned lead phrases ("governance layer", "governance platform", "more than a linter", "plataforma de governança", "camada de governança", "styringsplattform"): no remaining hitsarchgate check: 39/39 pass, 0 warnings (i18n parity and translation-drift rules included)archgate review-context: cleanbun run buildindocs/: passed, 169 pages builtSummary by CodeRabbit
archgate initacross all language versions to reference linting and rule enforcement