docs: Update getting-started with Let's Encrypt-style one-command setup#18
Merged
docs: Update getting-started with Let's Encrypt-style one-command setup#18
Conversation
- Rewrite getting-started with 'One Command Setup' as primary path - Add tabbed examples for CLI, Python SDK, and env vars - Document two setup paths: Quick Start vs UI-First - Add SDK quick reference section - Update identity docs with new capiscio init workflow - Consistent 'Just like Let's Encrypt' marketing message
There was a problem hiding this comment.
Pull request overview
This PR updates the main CapiscIO documentation to feature a new "Let's Encrypt-style" one-command setup flow. However, the documentation references APIs and commands from related PRs (capiscio-core#32 and capiscio-sdk-python#26) that have not been merged or implemented yet.
Changes:
- Introduces
capiscio initcommand as the primary setup method (command doesn't exist yet) - Documents new
CapiscIOPython SDK class with.connect()and.from_env()methods (class doesn't exist yet) - Updates identity documentation to emphasize did:key over did:web and promotes quick one-command setup
- Adds Node.js/TypeScript SDK examples (SDK doesn't exist - capiscio-node is CLI wrapper only)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 23 comments.
| File | Description |
|---|---|
| docs/getting-started/index.md | Replaces existing getting started guide with one-command setup using non-existent capiscio init CLI command and CapiscIO Python class |
| docs/identity/index.md | Updates agent identity guide to feature one-command setup, changes DID examples from did:web to did:key format, updates workflow diagrams |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Change reference from cli.md to cli/index.md to match actual file structure
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
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
Updates the main CapiscIO documentation to feature the new "Let's Encrypt" style one-command setup as the primary onboarding path.
Changes
Getting Started (
docs/getting-started/index.md)Identity (
docs/identity/index.md)key genexamples withcapiscio initMarketing Hooks
Consistent messaging across all docs:
Related PRs
capiscio initcommandCapiscIO.connect()API