Skip to content

docs: Update getting-started with Let's Encrypt-style one-command setup#18

Merged
beonde merged 2 commits intomainfrom
feature/init-docs
Feb 5, 2026
Merged

docs: Update getting-started with Let's Encrypt-style one-command setup#18
beonde merged 2 commits intomainfrom
feature/init-docs

Conversation

@beonde
Copy link
Member

@beonde beonde commented Feb 5, 2026

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)

  • Rewrites intro with "One command gives your AI agent a cryptographic identity"
  • Adds tabbed code examples: CLI, Python SDK, Environment Variables
  • Documents "Two Setup Paths": Quick Start vs UI-First
  • Adds "What You Get" section showing output files
  • Adds "SDK Quick Reference" with Python, Node.js, and CLI examples
  • Updates prerequisites table

Identity (docs/identity/index.md)

  • Updates tagline to reference Let's Encrypt
  • Replaces old key gen examples with capiscio init
  • Adds three setup paths: Quick Start, UI-First, Local Only
  • Updates DID workflow diagrams
  • Modernizes code examples to use new API

Marketing Hooks

Consistent messaging across all docs:

  • "Just like Let's Encrypt did for HTTPS"
  • "One command does everything"
  • Checkmark list of automatic actions (keys, DID, registration, badge)

Related PRs

  • capiscio-core#32: CLI capiscio init command
  • capiscio-sdk-python#26: Python CapiscIO.connect() API

- 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
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 init command as the primary setup method (command doesn't exist yet)
  • Documents new CapiscIO Python 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
@github-actions
Copy link

github-actions bot commented Feb 5, 2026

✅ Documentation Build Successful

The documentation build completed successfully and passed validation checks.

  • ✅ Build completed without errors
  • ✅ Critical files present (index.html, sitemap.xml, robots.txt)
  • ✅ Link validation completed

This PR will deploy to dev-docs.capisc.io when merged to main.

@beonde beonde merged commit e709e87 into main Feb 5, 2026
4 checks passed
@beonde beonde deleted the feature/init-docs branch February 5, 2026 22:50
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