Skip to content

docs: improve SDK discoverability and newcomer DX#78

Merged
Larry-Osakwe merged 1 commit intomainfrom
larry/sdk-dx-review
Feb 26, 2026
Merged

docs: improve SDK discoverability and newcomer DX#78
Larry-Osakwe merged 1 commit intomainfrom
larry/sdk-dx-review

Conversation

@Larry-Osakwe
Copy link
Contributor

@Larry-Osakwe Larry-Osakwe commented Feb 25, 2026

Summary

Comprehensive DX review of the SDK, addressing gaps that make it harder than necessary for newcomers to find the right entry point.

  • Root README: Expand "Which Package?" table from 3→5 rows (add MCP Client + Agents), add Key Concepts section
  • Docs site: Add 3 new guides (Delegated Access, Testing, Concepts), expand MCP Client guide, update nav
  • Agents examples: Upgrade from loose .py files to full runnable projects with pyproject.toml + README
  • Cross-links: Add package cross-references between MCP ↔ FastMCP READMEs
  • Fixes: docs.keycard.clouddocs.keycard.ai, add ADR 0003 to docs nav, delete stale .py.backup

Test plan

  • All 778 tests pass (104 oauth + 623 mcp + 51 mcp-fastmcp)
  • Read root README as a newcomer — verify all 5 use cases are discoverable
  • Verify cross-links between root README, package READMEs, and docs site resolve correctly

- Expand root README package table to include MCP Client and Agents
- Add Key Concepts section defining zones, delegated access, grants
- Add docs site guides: delegated-access, testing, concepts
- Expand MCP Client docs site guide with use-case breakdown
- Upgrade agents examples from loose .py files to full projects
- Add cross-reference notes between MCP and FastMCP READMEs
- Fix docs.keycard.cloud URL inconsistency
- Add ADR 0003 to docs.json nav, update welcome.mdx package table
Comment on lines +15 to +17
| Connect to MCP servers as a client | `pip install keycardai-mcp` | [MCP Client docs](packages/mcp/src/keycardai/mcp/client/) |
| Build agent-to-agent (A2A) services | `pip install keycardai-agents` | [Agents docs](packages/agents/) |
| Use the OAuth 2.0 client directly | `pip install keycardai-oauth` | [OAuth docs](packages/oauth/) |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These URLs dont lead to any doc, it ends at the respective folder? Was this intentional?

Copy link

@jerriclynsjohn jerriclynsjohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Larry-Osakwe Larry-Osakwe merged commit 9e18964 into main Feb 26, 2026
6 checks passed
@Larry-Osakwe Larry-Osakwe deleted the larry/sdk-dx-review branch February 26, 2026 20:53
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