Skip to content

docs: simplify README installation and quick start#389

Merged
rhuanbarreto merged 1 commit into
mainfrom
docs/simplify-readme-installation
May 30, 2026
Merged

docs: simplify README installation and quick start#389
rhuanbarreto merged 1 commit into
mainfrom
docs/simplify-readme-installation

Conversation

@rhuanbarreto

Copy link
Copy Markdown
Contributor

Summary

  • Replaced the verbose Installation section (30+ lines of shell/npm commands) with a single sentence linking to the installation guide, listing all supported methods: standalone script, npm, pip, dotnet, Go, gem, Maven, and proto
  • Removed the install step from Quick Start — assumes the user already installed via the guide, so "Initialize governance" is now step 1
  • Synced all 5 shim READMEs (go, maven, nuget, pypi, rubygem) per ARCH-013

Test plan

  • Verify the installation guide link resolves correctly
  • Confirm bun run validate passes (39/39 ADR rules, all tests green)
  • Review that the shim READMEs are byte-identical to the root README

Replace verbose installation commands with a single line linking to the
installation guide — the README now serves many package managers and
duplicating all options was unwieldy. Remove the install step from Quick
Start since users arrive there after installing.

Signed-off-by: Rhuan Barreto <rhuan@barreto.work>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying archgate-cli with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7486fd0
Status: ✅  Deploy successful!
Preview URL: https://290d8b69.archgate-cli.pages.dev
Branch Preview URL: https://docs-simplify-readme-install.archgate-cli.pages.dev

View logs

@github-actions

Copy link
Copy Markdown
Contributor

Code Coverage

Metric Value
Lines 90.3% (6735 / 7458)
Threshold 90% minimum — met
Platforms Linux + Windows

Full HTML report available in workflow artifacts.

Per-directory breakdown
Directory Coverage Lines
src/commands/ 88.0% 2082 / 2365
src/engine/ 93.1% 1379 / 1481
src/formats/ 100.0% 141 / 141
src/helpers/ 90.3% 3133 / 3471

@rhuanbarreto rhuanbarreto merged commit 10b286a into main May 30, 2026
23 checks passed
@rhuanbarreto rhuanbarreto deleted the docs/simplify-readme-installation branch May 30, 2026 22:56
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