diff --git a/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md b/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md index b402a3d..a7f18f2 100644 --- a/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md +++ b/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md @@ -1,4 +1,4 @@ -## API Documentation +# API Documentation Initial API documentation for pangolin. This documentation includes public endpoints, request/response formats, usage examples, and any limitations or constraints. This document is not complete but will be added to over time to compass more of the API. @@ -9,8 +9,6 @@ https://pangolin.yourdomain.com/api/v1/ I'll create an improved API documentation based on the files provided. Here's the updated markdown: -# API Documentation - ## 1. Public Endpoints ### 1.1 User Management diff --git a/packages/docusaurus/docs/05-Gerbil/02-developer-guide.md b/packages/docusaurus/docs/05-Gerbil/02-developer-guide.md index 87958ce..6728799 100644 --- a/packages/docusaurus/docs/05-Gerbil/02-developer-guide.md +++ b/packages/docusaurus/docs/05-Gerbil/02-developer-guide.md @@ -1,4 +1,4 @@ -# Developer Guide for the Gerbil Project +# Developer Guide This guide provides essential information for developers working on the Gerbil project, which is a Go application for managing WireGuard tunnels. It includes setup instructions, an overview of the project structure, development workflow, testing approach, and common troubleshooting steps. diff --git a/packages/docusaurus/docs/05-Gerbil/03-system-architecture-documentation.md b/packages/docusaurus/docs/05-Gerbil/03-system-architecture-documentation.md index 951e03f..938ce1f 100644 --- a/packages/docusaurus/docs/05-Gerbil/03-system-architecture-documentation.md +++ b/packages/docusaurus/docs/05-Gerbil/03-system-architecture-documentation.md @@ -1,4 +1,4 @@ -# System Architecture Documentation for the Gerbil Project +# System Architecture This document outlines the system architecture of the Gerbil project, a Go application designed for managing WireGuard tunnels. It includes a high-level overview, component interactions, data flow diagrams, design decisions and rationale, as well as system constraints and limitations.