Skip to content

📝 docs: standalone-first README rewrite + permissions reference#36

Merged
maximn merged 1 commit into
mainfrom
feat/story-9.2-readme-standalone-rewrite
Apr 9, 2026
Merged

📝 docs: standalone-first README rewrite + permissions reference#36
maximn merged 1 commit into
mainfrom
feat/story-9.2-readme-standalone-rewrite

Conversation

@maximn
Copy link
Copy Markdown
Contributor

@maximn maximn commented Apr 9, 2026

Summary

  • Restructure README to lead with standalone (zero-config) mode as the primary quick start path — single uses: testglance/action@v1 line, no with: block, no secrets
  • Move SaaS/platform quick start to secondary position; update all usage examples to remove api-key: unused / send-results: false workarounds
  • Update inputs table: api-key marked optional with empty default; send-results notes auto-force behavior
  • Expand permissions section with graceful-degradation table, minimal and full YAML blocks
  • Create docs/permissions.md as a dedicated permissions reference with behavior-if-missing details

Test plan

  • pnpm test passes (633/633 tests, docs-only change)
  • Verify README renders correctly on GitHub
  • Verify docs/permissions.md renders correctly and links work
  • Confirm standalone quick start example is first and most prominent section

Restructure README to lead with zero-config standalone mode (no api-key,
no signup, no outbound calls). Move SaaS/platform quick start to secondary
section. Update inputs table to reflect api-key as optional. Expand
permissions section with graceful-degradation table and minimal YAML
blocks. Create docs/permissions.md as a dedicated permissions reference.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 9, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 9, 2026

🔬 TestGlance

✅ test — 100.0% pass rate

████████████████ 100.0%
✅ 633 passed · ⏱️ 2.1s · 🏥 95/100


Signal Details
🔵 Health Score: 95 → 95

vs main

Metric main PR Delta
Pass rate 100.0% 100.0% +0.0%
Duration 2.1s 2.1s +0.9%

View Run → · 📄 HTML Report


Updated 2026-04-09T18:02:19.186Z

@maximn maximn merged commit c284f66 into main Apr 9, 2026
7 checks passed
@maximn maximn deleted the feat/story-9.2-readme-standalone-rewrite branch April 9, 2026 18:25
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