Skip to content

docs(readme): restructure around interactive, automation, and AI agent workflows#5

Merged
phil-accelbyte merged 2 commits into
mainfrom
docs/readme-improvements
May 5, 2026
Merged

docs(readme): restructure around interactive, automation, and AI agent workflows#5
phil-accelbyte merged 2 commits into
mainfrom
docs/readme-improvements

Conversation

@phil-accelbyte

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a Quick start section with three workflow modes (interactive, automation, AI agent) so readers can jump straight to the path that matches them
  • Adds a mode-comparison table mapping each workflow to the relevant flags and defaults
  • Consolidates authentication, profiles, and configuration as reference material below the workflow-driven intro
  • Moves build-from-source details out to CONTRIBUTING.md, leaving the README focused on use
  • Adds a security warning callout for credential handling
  • Fixes a broken #output-stability anchor (now #stable-json-output)

Test plan

  • Render README on GitHub and verify headings, tables, and callouts display correctly
  • Click the "stable JSON" links in the mode-comparison table and confirm they jump to the Stable JSON output section
  • Confirm the demo GIF still renders

…t workflows

- Add Quick start with three workflow modes (interactive, automation, AI agent)
- Add mode-comparison table mapping workflows to flags and behaviour
- Consolidate auth, profiles, and config as reference material
- Move build-from-source details to CONTRIBUTING
- Add security warning callout for credential handling
- Fix broken #output-stability anchor (now #stable-json-output)
Three dry-run security tests used non-isolated ags() which inherits the
host config dir. On macOS CI, parallel execution against the shared
default config could race and leave one test without the expected
'<token>' placeholder in stdout. Switch to ags_isolated() since these
tests verify dry-run output redaction and don't need real keychain
access.
@phil-accelbyte
phil-accelbyte merged commit 4ed4866 into main May 5, 2026
5 checks passed
@phil-accelbyte
phil-accelbyte deleted the docs/readme-improvements branch May 5, 2026 10:38
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