Skip to content

Add Scout CLI documentation#185

Merged
nitinstp23 merged 4 commits intomainfrom
docs/scout-cli
Apr 8, 2026
Merged

Add Scout CLI documentation#185
nitinstp23 merged 4 commits intomainfrom
docs/scout-cli

Conversation

@nitinstp23
Copy link
Copy Markdown
Contributor

@nitinstp23 nitinstp23 commented Apr 7, 2026 •
edited
Loading

Summary

  • Add comprehensive Scout CLI docs section with 15 pages covering all commands
  • Platform Commands (9 pages): login, logout, status, context, alerts, logs, metrics, traces, service-map, TUI mode
  • Open Source Commands (3 pages): config validate, config init, config test
  • Reference (2 pages): environment variables, global flags
  • Embed demo GIFs for each command
  • Add overview and installation pages
  • Update sidebar and getting-started page with CLI links

Test plan

  • make build passes with no broken links
  • make lint passes markdownlint checks
  • Visual review of sidebar navigation and page rendering via make start
  • Verify all GIFs render correctly on each page
  • Verify internal cross-links between command pages resolve
Screenshot 2026-04-07 at 3 40 50 PM

@nitinstp23
📝 docs: add Scout CLI documentation
455fa6b 
Add comprehensive documentation for the Scout CLI covering all commands,
grouped into Platform (backend-required) and Open Source (offline) sections,
with demo GIFs, flag reference tables, and a reference section for env vars
and global flags.
@nitinstp23 nitinstp23 requested a review from rnjn April 7, 2026 10:09
@nitinstp23 nitinstp23 merged commit ddb67bf into main Apr 8, 2026
5 checks passed
@nitinstp23 nitinstp23 deleted the docs/scout-cli branch April 8, 2026 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rnjn rnjn Awaiting requested review from rnjn

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nitinstp23