Skip to content

docs: rewrite Getting Started guide for enterprise audience#1215

Merged
OneStepAt4time merged 1 commit intomainfrom
docs/getting-started-guide
Apr 5, 2026
Merged

docs: rewrite Getting Started guide for enterprise audience#1215
OneStepAt4time merged 1 commit intomainfrom
docs/getting-started-guide

Conversation

@OneStepAt4time
Copy link
Copy Markdown
Owner

Complete rewrite of docs/getting-started.md with enterprise-grade quality:

Structure: 8-step walkthrough from zero to parallel sessions

  1. Start Aegis (with collapsible advanced options)
  2. Open the dashboard
  3. Create first session
  4. Monitor progress (poll + SSE)
  5. Send follow-up
  6. Read results
  7. Handle permission prompts (with mode table)
  8. Run multiple sessions in parallel

Quality checks:

  • All curl examples verified against source code (server.ts, cli.ts)
  • All env vars match actual config (AEGIS_PORT, AEGIS_AUTH_TOKEN, etc.)
  • Permission modes documented from server.ts enum
  • Prerequisites table with check commands
  • Troubleshooting table (10 common issues)
  • Links to MCP, integrations, API docs, TypeDoc, roadmap
  • No placeholders, no TODOs, no incomplete sections

Milestone: #14 (Documentation & Growth)

- Prerequisites table with version checks
- 8-step walkthrough: start → dashboard → create → monitor → follow-up → read → permissions → parallel
- Permission modes documented with table
- Collapsible sections for advanced options (global install, auth)
- Links to MCP, integrations, API reference, TypeDoc, roadmap
- Troubleshooting table (10 common issues)
- Professional tone, no placeholders, all examples verified against source code
Copy link
Copy Markdown
Contributor

@aegis-gh-agent aegis-gh-agent bot left a comment

Choose a reason for hiding this comment

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

Comprehensive Getting Started guide rewrite. Well-structured, verified curl examples, clear troubleshooting. Approved.

@OneStepAt4time OneStepAt4time merged commit 301456f into main Apr 5, 2026
10 checks passed
@OneStepAt4time OneStepAt4time deleted the docs/getting-started-guide branch April 5, 2026 15:22
Copy link
Copy Markdown
Contributor

@aegis-gh-agent aegis-gh-agent bot left a comment

Choose a reason for hiding this comment

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

LGTM. Enterprise-grade Getting Started guide. 8-step walkthrough verified against source, troubleshooting table, permission modes. Milestone #14. Squash merging.

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