Skip to content

Commit cfa5ed7

Browse files
committed
docs: reorganize documentation structure and add gitignore entries
1 parent 0856d3c commit cfa5ed7

File tree

3 files changed

+13
-18
lines changed

3 files changed

+13
-18
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,3 +165,6 @@ ccproxy/static/dashboard/
165165
*.duckdb
166166
.lazy.lua
167167
.ccproxy.toml
168+
169+
make
170+
run

docs/README.md renamed to docs/documentation-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Documentation
1+
# Documentation Guide
22

33
This directory contains the source files for the CCProxy API documentation, built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
44

mkdocs.yml

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -58,35 +58,27 @@ nav:
5858
- Configuration: getting-started/configuration.md
5959
- Plugin System:
6060
- Overview: PLUGIN_SYSTEM_DOCUMENTATION.md
61+
- Authoring Guide: PLUGIN_AUTHORING.md
6162
- Credential Balancer: plugins/credential-balancer.md
6263
- OAuth Integration: OAUTH_PLUGIN_ARCHITECTURE.md
6364
- Migration:
6465
- 0.2 Plugin‑First: migration/0.2-plugin-first.md
65-
- User Guide:
66-
- API Usage: user-guide/api-usage.md
67-
- MCP Integration: user-guide/mcp-integration.md
68-
- Authentication: user-guide/authentication.md
66+
- User Guide: user-guide/
6967
- Development:
68+
- Documentation Guide: documentation-guide.md
7069
- Auth Providers: development/auth-providers.md
7170
- Debugging Guide: development/debugging-with-proxy.md
71+
- Formatter Refactor Plan: development/formatter-refactor-plan.md
72+
- Formatter Refactor Progress: development/formatter-refactor-progress.md
7273
- Deployment:
7374
- SystemD Setup: systemd-setup.md
7475
- Metrics API: metrics-api.md
7576
- Examples: examples.md
7677
- Contributing: contributing.md
77-
- Code Reference:
78-
- API: reference/ccproxy/api/index.md
79-
- Auth: reference/ccproxy/auth/index.md
80-
- Core: reference/ccproxy/core/index.md
81-
- HTTP: reference/ccproxy/http/index.md
82-
- CLI: reference/ccproxy/cli/index.md
83-
- Configuration: reference/ccproxy/config/index.md
84-
- Models: reference/ccproxy/models/index.md
85-
- Scheduler: reference/ccproxy/scheduler/index.md
86-
- Services: reference/ccproxy/services/index.md
87-
- Streaming: reference/ccproxy/streaming/index.md
88-
- Templates: reference/ccproxy/templates/index.md
89-
- Utilities: reference/ccproxy/utils/index.md
78+
- Release Prep:
79+
- Release Status: release-v0.2-status.md
80+
- Open Items: v0.2-release-open-items.md
81+
- Code Reference: reference/
9082

9183
# Plugins
9284
plugins:

0 commit comments

Comments
 (0)