docs: improve SDK discoverability and newcomer DX#78
Merged
Larry-Osakwe merged 1 commit intomainfrom Feb 26, 2026
Merged
Conversation
- 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/) | |
There was a problem hiding this comment.
These URLs dont lead to any doc, it ends at the respective folder? Was this intentional?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive DX review of the SDK, addressing gaps that make it harder than necessary for newcomers to find the right entry point.
.pyfiles to full runnable projects withpyproject.toml+ READMEdocs.keycard.cloud→docs.keycard.ai, add ADR 0003 to docs nav, delete stale.py.backupTest plan