Skip to content

docs: add Getting Started guide (3 modes x 3 hosts)#78

Merged
hyoshi merged 1 commit intomainfrom
docs/getting-started
May 2, 2026
Merged

docs: add Getting Started guide (3 modes x 3 hosts)#78
hyoshi merged 1 commit intomainfrom
docs/getting-started

Conversation

@hyoshi
Copy link
Copy Markdown
Collaborator

@hyoshi hyoshi commented May 2, 2026

Adds docs/getting-started.md (+ .ja.md) covering all 9 mode/host combinations:

  • Demo in Claude Code / Desktop chat / Cowork
  • BYOD in Claude Code / Desktop chat / Cowork (incl. how to export XLSX, where to put it, how to import)
  • Auth (Live API) in Claude Code / Desktop chat / Cowork

README.md and README.ja.md gain a 3x3 'Choose your setup' matrix linking to the new walkthroughs.

Why

After Phase 3 plugin work landed (PR #77), non-engineers had no single doc explaining how modes (data source) relate to hosts (where the agent runs). This guide fills that gap and is the entry point for the user-onboarding flow.

Test plan

  • Markdown parses cleanly (rendered preview to be verified post-merge)
  • All cross-links resolve (docs/byod.md, docs/authentication.md, docs/cli.md)
  • No code changes; existing test suite passes (18 plugin/setup tests green)
  • No source code references this file beyond pyproject.toml long_description (unchanged)

Adds docs/getting-started.md (and .ja.md) covering Demo, BYOD, and Auth modes for Claude Code, Desktop chat, and Cowork. Each mode has full step-by-step walkthroughs including how to obtain data files (BYOD), where to place them, and how to import them per host.

README.md and README.ja.md gain a 'Choose your setup' section with the 3x3 matrix and a link to the new walkthroughs.

Resolves the user-onboarding gap identified after the Phase 3 plugin work — non-engineers had no single place explaining the relationship between modes (data source) and hosts (where the agent runs).
@hyoshi hyoshi merged commit 3954156 into main May 2, 2026
8 checks passed
@hyoshi hyoshi deleted the docs/getting-started branch May 2, 2026 00:58
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