Public GitHub repository for docs.waulter.eu — the official end-user and developer documentation for Waulter CMP.
This repository contains the source for the Waulter external documentation site. It is built with MkDocs and the Material for MkDocs theme.
Key principle: this repo contains only end-user and developer documentation. Internal architecture, security implementation details, and infrastructure information are maintained separately in the internal docs repository.
- Python 3.11+
- pip
pip install -r requirements.txtmkdocs serveThe site will be available at http://localhost:8000.
- Fork or branch from
main - Edit or add Markdown files under
docs/ - Run
mkdocs servelocally to preview your changes - Open a pull request against
main
- Write for a developer or technically-minded marketer audience
- Use concrete code examples — never pseudocode when real syntax is available
- Do not disclose internal technical architecture, security implementation, or infrastructure details (see Guardrails below)
- Keep pages focused: one concept per page
- Use admonitions (
!!! tip,!!! warning,!!! info) for callouts
The following topics must never appear in this repository:
| Prohibited topic | Reason |
|---|---|
| Internal API endpoints / base URLs | Security & confidentiality |
| Database schema or data model internals | Confidentiality |
| Infrastructure topology (servers, CDN) | Security |
Internal GTM field naming (ccid, etc.) |
May change; confuses end users |
| Security mechanisms (token signing, etc.) | Security |
| Pricing or commercial terms | Not appropriate for public docs |
| Unreleased features | No pre-announcements without sign-off |
The site deploys automatically to GitHub Pages via GitHub Actions on every push to
main. See .github/workflows/deploy.yml.
This documentation is available as raw Markdown for AI agent consumption.
https://raw.githubusercontent.com/waulter/waulter-docs/main/docs/<path>.md
Example:
https://raw.githubusercontent.com/waulter/waulter-docs/main/docs/features/gcm2.md
git clone https://github.com/waulter/waulter-docs.gitThe docs/ folder contains all content. The mkdocs.yml at the repo root
defines the navigation structure.
The canonical navigation tree is in the nav: section of mkdocs.yml.
Use this to understand how pages relate to each other and to generate
contextually relevant links.
Documentation content is © Waulter s.r.o. All rights reserved.