diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b14087aa..e469fbdd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ If you are new to the project, start with a docs fix, a focused bug fix, or an i | CLI runtime | `src/`, `lib/`, `config/`, `scripts/` | Add or update tests in `tests/` | | Dashboard UI | `ui/src/` | Run `cd ui && bun run validate` | | Web server and config APIs | `src/web-server/`, `src/api/`, `src/config/` | Add unit or integration coverage | -| Documentation | `README.md`, `docs/`, `CONTRIBUTING.md` | Keep user-facing docs in sync | +| Documentation | `https://docs.ccs.kaitran.ca`, `README.md`, `docs/`, `CONTRIBUTING.md` | Keep user-facing docs in sync | | Static assets | `assets/` | Verify screenshots and references still match | Useful directories: @@ -195,6 +195,7 @@ Releases are automated with semantic-release. - Bugs and features: https://github.com/kaitranntt/ccs/issues - Questions and discussion: https://github.com/kaitranntt/ccs/discussions +- Hosted docs: https://docs.ccs.kaitran.ca - User-facing docs: [README.md](./README.md) - Internal architecture notes: [docs/](./docs) - Community expectations: [`.github/CODE_OF_CONDUCT.md`](./.github/CODE_OF_CONDUCT.md) diff --git a/README.md b/README.md index 69391b4f..815aa9fb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Run Claude, Gemini, GLM, and any Anthropic-compatible API - concurrently, withou [![npm](https://img.shields.io/npm/v/@kaitranntt/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kaitranntt/ccs) [![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN) -**[Features & Pricing](https://ccs.kaitran.ca)** | **[Documentation](https://docs.ccs.kaitran.ca)** +**[Features & Pricing](https://ccs.kaitran.ca)** | **[Documentation Hub](https://docs.ccs.kaitran.ca)** @@ -29,6 +29,9 @@ Run Claude, Gemini, GLM, and any Anthropic-compatible API - concurrently, withou ## Quick Start +Looking for the full setup guide, command reference, provider guides, or troubleshooting? +Start at **https://docs.ccs.kaitran.ca**. + ### 1. Install ```bash @@ -608,10 +611,14 @@ Notes:
-## Documentation +## Documentation Hub + +If you are not sure where to start, open **https://docs.ccs.kaitran.ca** first. +The hosted docs are the best entry point for setup, command reference, provider guides, and troubleshooting. | Topic | Link | |-------|------| +| Docs Home | [docs.ccs.kaitran.ca](https://docs.ccs.kaitran.ca) | | Installation | [docs.ccs.kaitran.ca/getting-started/installation](https://docs.ccs.kaitran.ca/getting-started/installation) | | Configuration | [docs.ccs.kaitran.ca/getting-started/configuration](https://docs.ccs.kaitran.ca/getting-started/configuration) | | OAuth Providers | [docs.ccs.kaitran.ca/providers/oauth-providers](https://docs.ccs.kaitran.ca/providers/oauth-providers) | @@ -673,6 +680,6 @@ MIT License - see [LICENSE](LICENSE). --- -**[ccs.kaitran.ca](https://ccs.kaitran.ca)** | [Report Issues](https://github.com/kaitranntt/ccs/issues) | [Star on GitHub](https://github.com/kaitranntt/ccs) +**[ccs.kaitran.ca](https://ccs.kaitran.ca)** | **[docs.ccs.kaitran.ca](https://docs.ccs.kaitran.ca)** | [Report Issues](https://github.com/kaitranntt/ccs/issues) | [Star on GitHub](https://github.com/kaitranntt/ccs)