Skip to content

Add onboarding guide and README links - #37

Merged
susheem-k merged 1 commit into
mainfrom
docs/onboarding-guide
Jul 24, 2026
Merged

Add onboarding guide and README links#37
susheem-k merged 1 commit into
mainfrom
docs/onboarding-guide

Conversation

@susheem-k

Copy link
Copy Markdown
Collaborator

Summary

  • Add docs/guides/onboarding.md: mental model, prerequisites, bare-min integrate, FAQ, and honest “not doing today” scope
  • Link onboarding from the README nav, Quick start, and Documentation list (README stays a short funnel)
  • Cross-link from the field guide and control-plane status so newcomers land in one place

Test plan

  • Open README links to onboarding / field guide / control-plane status and confirm they resolve
  • Skim onboarding.md against current Quick start APIs (instrument_app, tokenops_run, wrap_complete)
  • Confirm “not doing today” points at control-plane status / roadmap without duplicating the full status matrix

Made with Cursor

Keep the README as a short funnel and link newcomers to one docs guide covering mental model, bare-min integrate, FAQ, and what TokenOps is not doing today.

Co-authored-by: Cursor <cursoragent@cursor.com>
@susheem-k
susheem-k merged commit c0f7181 into main Jul 24, 2026
3 checks passed
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