Skip to content

docs: ADK cookbook audit — README context, tutorial intros, style (DOCS-4271) - #33

Merged
sshettigar-aerospike merged 4 commits into
mainfrom
docs/DOCS-4271-cookbook-audit
Jun 25, 2026
Merged

docs: ADK cookbook audit — README context, tutorial intros, style (DOCS-4271)#33
sshettigar-aerospike merged 4 commits into
mainfrom
docs/DOCS-4271-cookbook-audit

Conversation

@sshettigar-aerospike

Copy link
Copy Markdown
Collaborator

Summary

  • Add "Why this exists" section to README with ADK and Aerospike context for developers landing cold
  • Rename sections for clarity (Services, Quickstart, Storage layout)
  • Rewrite "Why use this" bullets: remove em dashes, arbitrary bold, colloquialisms
  • Rewrite tutorial openers to lead with the production problem before the mechanism
  • Add "When to use this tutorial" sections to both tutorials, including a realistic ADK multi-agent use-case example
  • Fix style guide violations throughout: em dashes, "via", "spin up", bold in requirements table, informal phrasing
  • Update storage layout diagram to reflect segment records (not stale chunk terminology)
  • Add 3.11+/ to .gitignore

Jira

DOCS-4271

Made with Cursor

sshettigar-aerospike and others added 4 commits June 22, 2026 15:42
Tighten headings, voice, and terminology in session tutorials and
clarify demo-only concurrency limits before official docs migration.

Co-authored-by: Cursor <cursoragent@cursor.com>
- Add "Why this exists" section to README (ADK + Aerospike context)
- Rename "What's in here" → "Services", "Quick start" → "Quickstart"
- Fix "Why use this" bullets: remove em dashes, arbitrary bold, "via", "Spin up"
- Fix storage section heading em dash; update segment key format in diagram
- Add "When to use this tutorial" sections to both tutorials
- Rewrite tutorial openers to lead with production problem before mechanism
- Fix em dashes and semicolons in tutorial prose (not code)

Co-authored-by: Cursor <cursoragent@cursor.com>
…DOCS-4271)

- Replace "save as X" copy-paste instructions with explicit filenames
- Add 3.11+/ to .gitignore (stale venv artifact)

Co-authored-by: Cursor <cursoragent@cursor.com>
…' (DOCS-4271)

Co-authored-by: Cursor <cursoragent@cursor.com>
@sshettigar-aerospike
sshettigar-aerospike merged commit d99e14d into main Jun 25, 2026
6 checks passed
@sshettigar-aerospike
sshettigar-aerospike deleted the docs/DOCS-4271-cookbook-audit branch June 25, 2026 00:37
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.

2 participants