docs
This commit is contained in:
@@ -11,6 +11,7 @@
|
||||
- [Enabling Authentication for Applications](#enabling-authentication-for-applications)
|
||||
- [Adding a New Keycloak Client](#adding-a-new-keycloak-client)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Documentation](#documentation)
|
||||
- [Best Practices](#best-practices)
|
||||
|
||||
---
|
||||
@@ -1627,6 +1628,47 @@ If you're stuck:
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
This repository's documentation is built with [MkDocs](https://www.mkdocs.org/) using the [Material](https://squidfund.github.io/mkdocs-material/) theme and published automatically to Gitea Pages.
|
||||
|
||||
### Viewing the Docs
|
||||
|
||||
The live documentation site is available at:
|
||||
|
||||
**https://git.forteapps.net/Forte/launchpad/pages/**
|
||||
|
||||
### Editing Documentation
|
||||
|
||||
All documentation source files live in the `docs/` directory as Markdown. To make changes:
|
||||
|
||||
1. Edit the relevant `.md` file in `docs/`
|
||||
2. Commit and push to `main`
|
||||
3. The Gitea Actions workflow automatically rebuilds and deploys the site
|
||||
|
||||
### Local Preview
|
||||
|
||||
To preview documentation changes locally before pushing:
|
||||
|
||||
```bash
|
||||
# Install dependencies (one-time)
|
||||
pip install mkdocs mkdocs-material
|
||||
|
||||
# Start the local dev server
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
Then open `http://127.0.0.1:8000` in your browser. The server live-reloads on file changes.
|
||||
|
||||
### How It Works
|
||||
|
||||
- **Workflow**: `.gitea/workflows/docs.yaml` triggers on pushes to `main` that change `docs/**`, `mkdocs.yml`, `Dockerfile.docs`, or `nginx.conf`
|
||||
- **Build**: Installs MkDocs + Material theme, runs `mkdocs build`
|
||||
- **Deploy**: Force-pushes the built `site/` directory to the `gitea-pages` branch
|
||||
- **Serve**: Gitea Pages serves the static site from the `gitea-pages` branch
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Development Workflow
|
||||
|
||||
Reference in New Issue
Block a user