diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index c3d5c67d..2805b889 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -41,7 +41,7 @@ - **Feature Documentation**: When adding new features, update `docs/features.md` to include the new capability. This is the canonical list of all features shown to users. - **README**: The main `README.md` is a marketing/welcome page. Keep it brief with top features, quick start, and links to docs. All detailed documentation belongs in `docs/`. - **Link Format**: Use GitHub Pages URLs for documentation links, not relative paths: - - Docs: `https://wikid82.github.io/cpmp/` (index) or `https://wikid82.github.io/cpmp/features` (specific page, no `.md`) + - Docs: `https://wikid82.github.io/cpmp/docs/index.html` (index) or `https://wikid82.github.io/cpmp/docs/features.html` (specific page) - Repo files (CONTRIBUTING, LICENSE): `https://github.com/Wikid82/cpmp/blob/main/CONTRIBUTING.md` - Issues/Discussions: `https://github.com/Wikid82/cpmp/issues` or `https://github.com/Wikid82/cpmp/discussions` diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e35d1511..f022e839 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -166,18 +166,18 @@ jobs:

๐Ÿ“š Getting Started

+
+

โœจ Features Overview

+

See everything CPMP can do - security, monitoring, automation, and more!

+ View All Features โ†’ +
+

๐Ÿ  Getting Started Guide Start Here

Your first setup in just 5 minutes! We'll walk you through everything step by step.

Read the Guide โ†’
-
-

๐Ÿ“– README Essential

-

Learn what the app does, how to install it, and see examples of what you can build.

- Read More โ†’ -
-

๐Ÿ“ฅ Import Guide

Already using Caddy? Learn how to bring your existing configuration into the app.

@@ -185,6 +185,21 @@ jobs:
+

๐Ÿ”’ Security

+
+
+

๐Ÿ›ก๏ธ Security Features

+

CrowdSec integration, WAF, geo-blocking, rate limiting, and access control lists.

+ Learn More โ†’ +
+ +
+

๐Ÿ” ACME Staging

+

Test SSL certificates without hitting rate limits using Let's Encrypt staging.

+ View Guide โ†’ +
+
+

๐Ÿ”ง Developer Documentation

@@ -220,15 +235,15 @@ jobs: Stuck? Have questions? We're here to help!

- ๐Ÿ’ฌ Ask a Question - ๐Ÿ› Report a Bug - โญ View on GitHub diff --git a/README.md b/README.md index 7f4c147d..22de5ee7 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ | ๐ŸŒ **WebSocket Support** | Perfect for real-time apps and chat services | | โšก **Zero Downtime** | Hot-reload configuration without restarts | -**[See all features โ†’](https://wikid82.github.io/cpmp/features)** +**[See all features โ†’](https://wikid82.github.io/cpmp/docs/features.html)** --- @@ -47,7 +47,7 @@ docker compose up -d Open **http://localhost:8080** โ€” that's it! ๐ŸŽ‰ -**[Full documentation โ†’](https://wikid82.github.io/cpmp/)** +**[Full documentation โ†’](https://wikid82.github.io/cpmp/docs/index.html)** --- @@ -65,7 +65,7 @@ We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) to get s

MIT License ยท - Documentation ยท + Documentation ยท Releases