Skip to content

Commit 157f6ce

Browse files
authored
Merge pull request #71 from barbacane-dev/docs/seo-improvements
docs(seo): rewrite top-impression page titles, fix AWX/Makefile search noise
2 parents 3ed8715 + 5f49ba3 commit 157f6ce

7 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/SUMMARY.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
# User Guide
66

7-
- [Getting Started](guide/getting-started.md)
8-
- [Spec Configuration](guide/spec-configuration.md)
9-
- [Dispatchers](guide/dispatchers.md)
10-
- [Middlewares](guide/middlewares/index.md)
7+
- [Getting started](guide/getting-started.md)
8+
- [Spec configuration](guide/spec-configuration.md)
9+
- [Dispatchers (request routing)](guide/dispatchers.md)
10+
- [Middlewares (auth, rate limit, AI)](guide/middlewares/index.md)
1111
- [Authentication](guide/middlewares/authentication.md)
1212
- [Authorization](guide/middlewares/authorization.md)
1313
- [Traffic Control](guide/middlewares/traffic-control.md)
@@ -17,21 +17,21 @@
1717
- [AI Gateway](guide/middlewares/ai-gateway.md)
1818
- [Secrets](guide/secrets.md)
1919
- [Observability](guide/observability.md)
20-
- [Control Plane](guide/control-plane.md)
20+
- [Control plane (REST API)](guide/control-plane.md)
2121
- [Web UI](guide/web-ui.md)
2222
- [MCP Server](guide/mcp.md)
2323
- [Linting with Vacuum](guide/vacuum.md)
2424
- [FIPS 140-3 Compliance](guide/fips.md)
2525

2626
# Reference
2727

28-
- [CLI Reference](reference/cli.md)
28+
- [CLI reference](reference/cli.md)
2929
- [Spec Extensions](reference/extensions.md)
3030
- [Artifact Format](reference/artifact.md)
3131
- [Reserved Endpoints](reference/endpoints.md)
3232

3333
# Contributing
3434

3535
- [Architecture](contributing/architecture.md)
36-
- [Development Guide](contributing/development.md)
37-
- [Plugin Development](contributing/plugins.md)
36+
- [Development setup](contributing/development.md)
37+
- [WASM plugin development](contributing/plugins.md)

docs/contributing/development.md

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

33
This guide helps you set up a development environment for contributing to Barbacane.
44

docs/contributing/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Plugin Development Guide
1+
# WASM plugin development
22

33
This guide explains how to create WASM plugins for Barbacane.
44

docs/guide/control-plane.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Control Plane
1+
# Control plane
22

33
The Barbacane Control Plane provides a REST API for managing API specifications, plugins, and compiled artifacts. It enables centralized management of your API gateway configuration with PostgreSQL-backed storage and async compilation.
44

@@ -319,9 +319,9 @@ The control plane notifies all connected data planes, which download the new art
319319

320320
## Web UI
321321

322-
The control plane includes a web-based management interface at `http://localhost:5173` (when running the UI development server).
322+
The control plane includes a web-based management interface at `http://localhost:5173` (once the dev server is running locally).
323323

324-
### Running the UI
324+
### Starting the web UI dev server
325325

326326
```bash
327327
# Using Makefile

docs/guide/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting Started
1+
# Getting started
22

33
This guide walks you through creating your first Barbacane-powered API gateway.
44

docs/guide/spec-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Spec Configuration
1+
# Spec configuration
22

33
Barbacane extends OpenAPI and AsyncAPI specs with custom `x-barbacane-*` extensions. These tell the gateway how to route requests, apply middleware, and connect to backends.
44

docs/reference/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CLI Reference
1+
# CLI reference
22

33
Barbacane provides two command-line tools:
44
- **barbacane** - Data plane (gateway) for compiling specs and serving traffic

0 commit comments

Comments
 (0)