fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-12 21:30:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up formatting in docu

Browse source
This commit is contained in:
Owen 2025-02-27 10:30:23 -05:00
parent 9459924f92
commit 8b8d75992c
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
3 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/docusaurus/docs/03-Pangolin/04-api-documentation.md
View file

@ -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

2
packages/docusaurus/docs/05-Gerbil/02-developer-guide.md
View file

@ -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.

2
packages/docusaurus/docs/05-Gerbil/03-system-architecture-documentation.md
View file

@ -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.