Skip to content

Rewrite auth doc; add quickstart, recipes, and demo upload playbook#8

Closed
arnav2 wants to merge 1 commit intomainfrom
docs/auth-quickstart-recipes
Closed

Rewrite auth doc; add quickstart, recipes, and demo upload playbook#8
arnav2 wants to merge 1 commit intomainfrom
docs/auth-quickstart-recipes

Conversation

@arnav2
Copy link
Copy Markdown
Contributor

@arnav2 arnav2 commented May 1, 2026

Summary

  • docs/authentication.md — rewrite around user-scoped API keys (the actual shipped auth model) instead of the legacy admin JWT impersonation flow; add hosted-docs link and dashboard walkthrough GIF.
  • docs/quickstart.md (new) — zero-to-semantic-search walkthrough with placeholder IDs and expected output. Referenced from the README.
  • docs/recipes.md (new) — bulk ingest, piping, scripting, and CI patterns.
  • .github/UPLOAD_DEMO_VIDEO.md (new) — playbook for uploading the demo MP4 to GitHub user-attachments so the README can embed it inline.

Test plan

  • Verify all three docs render correctly on GitHub
  • Confirm internal links resolve (README → docs/authentication.md, docs/quickstart.md, docs/recipes.md)
  • Sanity-check that the auth doc matches the actual login flow (api-key, /tmp/kscli/.credentials, kscli whoami)

- docs/authentication.md: rewrite around user-scoped API keys (the actual
  shipped auth model) instead of the legacy admin JWT impersonation flow;
  add hosted-docs link and dashboard walkthrough GIF.
- docs/quickstart.md: zero-to-search walkthrough with placeholder IDs and
  expected output, referenced from the README.
- docs/recipes.md: bulk ingest, piping, scripting, and CI patterns.
- .github/UPLOAD_DEMO_VIDEO.md: playbook for uploading the demo MP4 to
  GitHub user-attachments so the README can embed it inline.
@arnav2 arnav2 closed this May 1, 2026
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