Skip to content

docs: show AI-assisted daily workflow - #196

Merged
forhappy merged 4 commits into
mainfrom
codex/readme-graph-workflow
Aug 7, 2026
Merged

docs: show AI-assisted daily workflow#196
forhappy merged 4 commits into
mainfrom
codex/readme-graph-workflow

Conversation

@forhappy

@forhappy forhappy commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • retain the abstract README overview that explains Compass's value proposition
  • make AI agent integration the primary daily workflow with compass init, compass install, and compass watch
  • explain agent auto-detection, the portable Agent Skills fallback, explicit platform selection, and host activation
  • describe the installed skill accurately: focused queries first, GRAPH_REPORT.md for repository-wide context, then minimal source inspection
  • keep the high-level workspace graph as an optional human-review path
  • show all 32 workspace packages, 100 non-development dependency edges, and seven functional areas

Impact

The README now leads developers toward AI-assisted codebase navigation and tells them how to verify or override agent detection. It preserves direct graph exploration for human review. Product behavior and compatibility contracts are unchanged.

Validation

  • cargo test -p compass-cli --test install_cli --locked (22 passed)
  • cargo metadata --locked --no-deps --format-version 1
  • npm test -w @compass/viewer-tests -- graph-parity.spec.ts (8 passed)
  • git diff --check

AI assistance

Codex drafted and reviewed the documentation changes. The agent-install claims were verified against the CLI implementation, shipped Compass skill, setup guide, and installer integration tests.

@forhappy forhappy changed the title docs: show daily graph workflow docs: show AI-assisted daily workflow Aug 7, 2026
@forhappy
forhappy marked this pull request as ready for review August 7, 2026 14:48
@forhappy
forhappy merged commit 7bf87e4 into main Aug 7, 2026
14 checks passed
@forhappy
forhappy deleted the codex/readme-graph-workflow branch August 7, 2026 18:11
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