Skip to content

Commit 6995c2c

Browse files
authored
Docs Overhaul: Goal-Centric Navigation & Dark Mode (#3)
* docs: overhaul navigation structure and enable dark mode * fix: comment out watch paths to prevent CI build errors * fix: completely comment out watch section to prevent CI errors * fix(ci): checkout all required repositories for monorepo build * chore: trigger ci after fixing upstream docs * fix: correct link to node cli scoring guide
1 parent 7514d36 commit 6995c2c

12 files changed

Lines changed: 1133 additions & 259 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,43 @@ jobs:
4141
path: capiscio-docs
4242
fetch-depth: 0 # Full history for git-revision-date plugin
4343

44-
- name: Checkout a2a-security
44+
- name: Checkout capiscio-core
4545
uses: actions/checkout@v4
4646
with:
47-
repository: capiscio/a2a-security
48-
path: a2a-security
47+
repository: capiscio/capiscio-core
48+
path: capiscio-core
4949
fetch-depth: 0
5050
token: ${{ secrets.GITHUB_TOKEN }}
51-
52-
- name: Checkout capiscio-cli
51+
52+
- name: Checkout capiscio-sdk-python
53+
uses: actions/checkout@v4
54+
with:
55+
repository: capiscio/capiscio-sdk-python
56+
path: capiscio-sdk-python
57+
fetch-depth: 0
58+
token: ${{ secrets.GITHUB_TOKEN }}
59+
60+
- name: Checkout capiscio-python
61+
uses: actions/checkout@v4
62+
with:
63+
repository: capiscio/capiscio-python
64+
path: capiscio-python
65+
fetch-depth: 0
66+
token: ${{ secrets.GITHUB_TOKEN }}
67+
68+
- name: Checkout capiscio-node
69+
uses: actions/checkout@v4
70+
with:
71+
repository: capiscio/capiscio-node
72+
path: capiscio-node
73+
fetch-depth: 0
74+
token: ${{ secrets.GITHUB_TOKEN }}
75+
76+
- name: Checkout validate-a2a
5377
uses: actions/checkout@v4
5478
with:
55-
repository: capiscio/capiscio-cli
56-
path: capiscio-cli
79+
repository: capiscio/validate-a2a
80+
path: validate-a2a
5781
fetch-depth: 0
5882
token: ${{ secrets.GITHUB_TOKEN }}
5983

Makefile

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.PHONY: install serve build clean
2+
3+
VENV = .venv
4+
PYTHON = $(VENV)/bin/python
5+
PIP = $(VENV)/bin/pip
6+
MKDOCS = $(VENV)/bin/mkdocs
7+
8+
$(VENV)/bin/activate: requirements-docs.txt
9+
python3 -m venv $(VENV)
10+
$(PIP) install -r requirements-docs.txt
11+
touch $(VENV)/bin/activate
12+
13+
install: $(VENV)/bin/activate
14+
15+
serve: install
16+
$(MKDOCS) serve
17+
18+
build: install
19+
$(MKDOCS) build
20+
21+
clean:
22+
rm -rf $(VENV)
23+
rm -rf site

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This repository contains the landing page for CapiscIO documentation at [docs.ca
66

77
The landing page serves as a navigation hub for all CapiscIO product documentation:
88

9-
- **A2A Security** (`/a2a-security`) - Runtime security middleware
9+
- **Python SDK** (`/capiscio-sdk-python`) - Runtime security middleware
1010
- **CLI Tool** (`/cli`) - Command-line utilities (coming soon)
1111

1212
## Local Development

docs/community/contributing.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ Thank you for your interest in contributing to CapiscIO! We welcome contribution
1616

1717
CapiscIO is organized as a monorepo documentation site with multiple products:
1818

19-
- **[A2A Security](https://github.com/capiscio/a2a-security)** - Python middleware for Agent-to-Agent Protocol security
20-
- **[CapiscIO CLI](https://github.com/capiscio/capiscio-cli)** - Command-line tools for A2A validation and testing
19+
- **[Python SDK](https://github.com/capiscio/capiscio-sdk-python)** - Python middleware for Agent-to-Agent Protocol security
20+
- **[Node.js CLI](https://github.com/capiscio/capiscio-node)** - Command-line tools for A2A validation and testing
21+
- **[Python CLI](https://github.com/capiscio/capiscio-python)** - Python wrapper for the CLI
2122
- **[Documentation](https://github.com/capiscio/capiscio-docs)** - This unified documentation site
2223

2324
## 🚀 How to Contribute
@@ -26,8 +27,9 @@ CapiscIO is organized as a monorepo documentation site with multiple products:
2627

2728
Found a bug or have a feature request? Please open an issue in the relevant repository:
2829

29-
- **[A2A Security Issues](https://github.com/capiscio/a2a-security/issues){:target="_blank"}
30-
- [CapiscIO CLI Issues](https://github.com/capiscio/capiscio-cli/issues){:target="_blank"}
30+
- **[Python SDK Issues](https://github.com/capiscio/capiscio-sdk-python/issues){:target="_blank"}
31+
- **[Node.js CLI Issues](https://github.com/capiscio/capiscio-node/issues){:target="_blank"}
32+
- **[Python CLI Issues](https://github.com/capiscio/capiscio-python/issues){:target="_blank"}
3133
- [Documentation Issues](https://github.com/capiscio/capiscio-docs/issues){:target="_blank"}
3234

3335
!!! tip "Good Bug Reports Include"
@@ -41,8 +43,9 @@ Found a bug or have a feature request? Please open an issue in the relevant repo
4143

4244
Each product has its own contributing guidelines:
4345

44-
- [A2A Security Contributing Guide](https://github.com/capiscio/a2a-security/blob/main/CONTRIBUTING.md)
45-
- [CLI Contributing Guide](https://github.com/capiscio/capiscio-cli/blob/main/CONTRIBUTING.md)
46+
- [Python SDK Contributing Guide](https://github.com/capiscio/capiscio-sdk-python/blob/main/CONTRIBUTING.md)
47+
- [Node.js CLI Contributing Guide](https://github.com/capiscio/capiscio-node/blob/main/CONTRIBUTING.md)
48+
- [Python CLI Contributing Guide](https://github.com/capiscio/capiscio-python/blob/main/CONTRIBUTING.md)
4649

4750
### 📝 Contributing to Documentation
4851

@@ -52,8 +55,8 @@ Documentation contributions are always welcome! Here's how:
5255
Each product maintains its own docs that are aggregated into the unified site. You can edit docs in the product repo and they'll automatically appear in docs.capisc.io.
5356

5457
**1. Fork the relevant repository**
55-
- For product docs: Fork the product repo (e.g., `a2a-security`)
56-
- For landing pages: Fork `capiscio-docs`
58+
- For product docs: Fork the product repo (e.g., `capiscio-sdk-python`)
59+
- For the main site: Fork `capiscio-docs`
5760

5861
2. **Make your changes locally**
5962
```bash
@@ -113,7 +116,7 @@ The unified documentation site aggregates all product docs:
113116

114117
**Test a single product**:
115118
```bash
116-
cd a2a-security # or capiscio-cli
119+
cd capiscio-sdk-python # or capiscio-node
117120
mkdocs serve
118121
```
119122

@@ -122,8 +125,8 @@ mkdocs serve
122125
# Directory structure needed:
123126
# parent/
124127
# ├── capiscio-docs/
125-
# ├── a2a-security/
126-
# └── capiscio-cli/
128+
# ├── capiscio-sdk-python/
129+
# └── capiscio-node/
127130

128131
cd capiscio-docs
129132
mkdocs build -f mkdocs-unified.yml
@@ -154,7 +157,7 @@ Our documentation uses a confident, helpful voice:
154157
**Example:**
155158

156159
```python
157-
from capiscio_a2a_security import secure
160+
from capiscio_sdk import secure
158161

159162
# Wrap your agent with security
160163
secured_agent = secure(MyAgentExecutor())
@@ -180,8 +183,8 @@ We use Material for MkDocs with these extensions:
180183

181184
By participating in this project, you agree to abide by our Code of Conduct:
182185

183-
- [A2A Security Code of Conduct](https://github.com/capiscio/a2a-security/blob/main/CODE_OF_CONDUCT.md)
184-
- [CLI Code of Conduct](https://github.com/capiscio/capiscio-cli/blob/main/CODE_OF_CONDUCT.md)
186+
- [Python SDK Code of Conduct](https://github.com/capiscio/capiscio-sdk-python/blob/main/CODE_OF_CONDUCT.md)
187+
- [Node.js CLI Code of Conduct](https://github.com/capiscio/capiscio-node/blob/main/CODE_OF_CONDUCT.md)
185188

186189
## Questions?
187190

@@ -194,7 +197,7 @@ By participating in this project, you agree to abide by our Code of Conduct:
194197
## See Also
195198

196199
- **[Getting Help](support.md)** - Support resources and FAQs
197-
- **[A2A Security Contributing](https://github.com/capiscio/a2a-security/blob/main/CONTRIBUTING.md){:target="_blank"}** - Product-specific guidelines
198-
- **[CapiscIO CLI Contributing](https://github.com/capiscio/capiscio-cli/blob/main/CONTRIBUTING.md){:target="_blank"}** - CLI contribution guide
200+
- **[Python SDK Contributing](https://github.com/capiscio/capiscio-sdk-python/blob/main/CONTRIBUTING.md){:target="_blank"}** - Product-specific guidelines
201+
- **[Node.js CLI Contributing](https://github.com/capiscio/capiscio-node/blob/main/CONTRIBUTING.md){:target="_blank"}** - CLI contribution guide
199202

200203
Thank you for helping make CapiscIO better! 🚀

docs/community/support.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,39 @@ Need help with CapiscIO? Here are the best ways to get support.
66

77
Start with the documentation for your specific product:
88

9-
- **[A2A Security Documentation](../a2a-security/index.md)** - Security middleware guides and API reference
10-
- **[CapiscIO CLI Documentation](../capiscio-cli/README.md)** - Command-line tools and validation
9+
- **[Python SDK Documentation](../capiscio-python-sdk/index.md)** - Security middleware guides and API reference
10+
- **[Node.js CLI Documentation](../capiscio-node-js-cli/index.md)** - Command-line tools and validation
11+
- **[Python CLI Documentation](../capiscio-python-cli/index.md)** - Python wrapper for the CLI
1112

1213
## Quick Links
1314

1415
### Getting Started
1516

16-
- [A2A Security Quick Start](../a2a-security/getting-started/quickstart.md)
17-
- [CapiscIO CLI Getting Started](../capiscio-cli/README.md)
17+
- [Python SDK Quick Start](../capiscio-python-sdk/getting-started/quickstart.md)
18+
- [Node.js CLI Getting Started](../capiscio-node-js-cli/index.md)
1819
- [A2A Protocol Specification](https://github.com/a2aproject/A2A){:target="_blank"}
1920

2021
### Common Tasks
2122

22-
**For A2A Security:**
23+
**For Python SDK:**
2324

24-
- [Installation & Setup](../a2a-security/getting-started/installation.md)
25-
- [Configuration Guide](../a2a-security/guides/configuration.md)
26-
- [Core Concepts](../a2a-security/getting-started/concepts/)
25+
- [Installation & Setup](../capiscio-python-sdk/getting-started/installation.md)
26+
- [Configuration Guide](../capiscio-python-sdk/guides/configuration.md)
27+
- [Core Concepts](../capiscio-python-sdk/getting-started/concepts.md)
2728

28-
**For CapiscIO CLI:**
29+
**For Node.js CLI:**
2930

30-
- [Validation Process](../capiscio-cli/validation-process.md)
31-
- [Scoring System](../capiscio-cli/scoring-system/)
32-
- [Architecture](../capiscio-cli/architecture.md)
31+
- [Validation Process](../concepts/validation.md)
32+
- [Scoring System](../concepts/scoring.md)
33+
- [Architecture](../capiscio-node-js-cli/reference/architecture.md)
3334

3435
## GitHub Resources
3536

3637
### Issues & Bug Reports
3738

3839
Report bugs or request features in the relevant repository:
3940

40-
- [A2A Security Issues](https://github.com/capiscio/a2a-security/issues){:target="_blank"}
41+
- [Python SDK Issues](https://github.com/capiscio/capiscio-sdk-python/issues){:target="_blank"}
4142
- [CapiscIO CLI Issues](https://github.com/capiscio/capiscio-cli/issues){:target="_blank"}
4243
- [Documentation Issues](https://github.com/capiscio/capiscio-docs/issues){:target="_blank"}
4344

@@ -60,10 +61,10 @@ Want to contribute? See our [Contributing Guide](contributing.md) for details on
6061

6162
## Package Resources
6263

63-
### Python (A2A Security)
64+
### Python (SDK)
6465

65-
- **PyPI**: [a2a-security package](https://pypi.org/project/a2a-security.md)
66-
- **Installation**: `pip install a2a-security`
66+
- **PyPI**: [capiscio-sdk-python package](https://pypi.org/project/capiscio-sdk-python/)
67+
- **Installation**: `pip install capiscio-sdk-python`
6768
- **Requirements**: Python 3.10+
6869

6970
### Node.js (CapiscIO CLI)
@@ -87,22 +88,22 @@ CapiscIO implements the Agent-to-Agent (A2A) Protocol. Learn more:
8788
We welcome contributions! Check out:
8889

8990
- [Contributing Guidelines](contributing.md)
90-
- [Code of Conduct](https://github.com/capiscio/a2a-security/blob/main/CODE_OF_CONDUCT.md)
91-
- [Security Policy](https://github.com/capiscio/a2a-security/blob/main/SECURITY.md)
91+
- [Code of Conduct](https://github.com/capiscio/capiscio-sdk-python/blob/main/CODE_OF_CONDUCT.md)
92+
- [Security Policy](https://github.com/capiscio/capiscio-sdk-python/blob/main/SECURITY.md)
9293

9394
### Stay Updated
9495

9596
- **GitHub**: Watch the repositories for updates
96-
- [capiscio/a2a-security](https://github.com/capiscio/a2a-security)
97-
- [capiscio/capiscio-cli](https://github.com/capiscio/capiscio-cli)
98-
- **Releases**: Check [Releases](https://github.com/capiscio/a2a-security/releases) for changelogs
97+
- [capiscio/capiscio-sdk-python](https://github.com/capiscio/capiscio-sdk-python)
98+
- [capiscio/capiscio-node](https://github.com/capiscio/capiscio-node)
99+
- **Releases**: Check [Releases](https://github.com/capiscio/capiscio-sdk-python/releases) for changelogs
99100

100101
## Security Issues
101102

102103
Found a security vulnerability? Please report it responsibly:
103104

104105
- **Do not** open a public issue
105-
- See [Security Policy](https://github.com/capiscio/a2a-security/blob/main/SECURITY.md) for reporting process
106+
- See [Security Policy](https://github.com/capiscio/capiscio-sdk-python/blob/main/SECURITY.md) for reporting process
106107
- Security issues are handled with priority
107108

108109
## Frequently Asked Questions
@@ -112,13 +113,13 @@ Found a security vulnerability? Please report it responsibly:
112113

113114
### Installation Issues
114115

115-
**Q: `pip install capiscio-a2a-security` fails**
116+
**Q: `pip install capiscio-sdk-python` fails**
116117

117118
A: Ensure you have Python 3.10 or higher:
118119
```bash
119120
python --version
120121
pip install --upgrade pip
121-
pip install a2a-security
122+
pip install capiscio-sdk-python
122123
```
123124

124125
**Q: CLI command not found after installation**
@@ -140,7 +141,7 @@ capiscio validate path/to/agent-card.json
140141

141142
Or programmatically with Python:
142143
```python
143-
from a2a_security import validate_message
144+
from capiscio_sdk import validate_message
144145

145146
result = validate_message(message_data)
146147
```
@@ -155,9 +156,9 @@ A: Check the [CLI repository examples](https://github.com/capiscio/capiscio-cli/
155156

156157
A: Each repository has its own test suite:
157158

158-
**A2A Security**:
159+
**Python SDK**:
159160
```bash
160-
cd a2a-security
161+
cd capiscio-sdk-python
161162
pip install -e ".[dev]"
162163
pytest
163164
```
@@ -182,7 +183,7 @@ mkdocs serve
182183

183184
If you can't find what you're looking for:
184185

185-
1. Search existing [GitHub Issues](https://github.com/capiscio/a2a-security/issues)
186+
1. Search existing [GitHub Issues](https://github.com/capiscio/capiscio-sdk-python/issues)
186187
2. Check the [A2A Specification](https://github.com/a2aproject/A2A)
187188
3. Open a new issue with details about your problem
188189

0 commit comments

Comments
 (0)