You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`kuadrant://docs/authorino-features` - Authorino authentication/authorization features
150
+
Documentation is fetched from upstream GitHub repos (kuadrant-operator, authorino) and cached for 15 minutes. This keeps docs.kuadrant.io as the single source of truth.
151
+
152
+
### Policy References
153
+
-`kuadrant://docs/gateway-api` - Gateway API overview
-`kuadrant://docs/auth-for-developers` - Auth for app devs
172
170
173
171
Access these resources in Claude by asking questions like:
174
172
- "Show me the Kuadrant rate limiting documentation"
@@ -829,40 +827,29 @@ rates:
829
827
```
830
828
831
829
832
-
## Updating Documentation
833
-
834
-
Documentation is stored as markdown files in `docs/` and embedded into the binary at build time using Go's `//go:embed` directive.
830
+
## Documentation Architecture
835
831
836
-
### Quick Update
832
+
Documentation is fetched at runtime from upstream GitHub repos and cached in memory for 15 minutes. This keeps docs.kuadrant.io as the single source of truth.
837
833
838
-
```bash
839
-
# 1. Fetch latest docs from upstream repos
840
-
./update-docs.sh
841
-
842
-
# 2. Review extracted content
843
-
cat extracted-docs/extraction-summary.txt
834
+
### How It Works
844
835
845
-
# 3. Update markdown files in docs/ as needed
846
-
# Compare with extracted-docs/ and update
847
-
848
-
# 4. Rebuild to embed changes
849
-
go build -o kuadrant-mcp-server
850
-
```
851
-
852
-
### Architecture
853
-
854
-
- **`docs/`** - Markdown files for each resource (committed to git)
855
-
- **`//go:embed`** - Files embedded into binary at build time
856
-
- **Single binary** - No external files needed at runtime
836
+
- Resources are fetched from `raw.githubusercontent.com` on first request
837
+
- Content is cached in memory with 15-minute TTL
838
+
- If fetch fails, a fallback with link to docs.kuadrant.io is returned
839
+
- No local docs to maintain
857
840
858
841
### Adding New Resources
859
842
860
-
1. Create markdown file: `docs/newpolicy.md`
861
-
2. Add mapping in `resources.go`:
843
+
Add an entry to `resourceMapping` in `resources.go`:
0 commit comments