Project Overview
Why This Project Exists
The Need for Unified Documentation
Not everyone in the company has access to Confluence, creating information silos. We needed a central, accessible documentation platform that works for all teams.
Documentation Close to Code
We want to enable developers to keep their documentation close to the source code and update them together with code changes. This ensures docs stay current and are part of the development workflow.
Multiple Repositories, One Site
With documentation scattered across dozens of repositories, teams struggled to discover and search across projects. This unified docs site aggregates all /docs folders into a single, searchable portal.
Goals
- Searchable: Fast, comprehensive search across all documentation
- Unified: One place to find docs from all teams and projects
- Easy to maintain: Docs live in their repositories, automatically aggregated
- Customizable: Support for Markdown, Mermaid diagrams, custom styling, and more
Current State
This is our second attempt at hosting an internal docs portal. The first version was based on an exploration by our architect Markus Wolf. It served us well as a proof of concept, demonstrating the value of a unified docs platform.
However, developing and maintaining a custom in-house solution doesn't scale long-term. We evaluated MkDocs as an open-source alternative and found it superior in key areas:
- Solid search (the main criteria for knowledge management)
- Quality-of-life improvements: Dark mode, excellent table of contents, tag aggregation
- Active ecosystem with plugins and community support
Migration Progress
We've started the evaluation and migration process:
- ✅ Proof of concept with automatic content updates - Complete
- ✅ Testing with representative test repos - Complete
- 🔄 Installation in all relevant GitHub organizations - Ongoing
- ⏳ Migration to original domain (
https://docs.statista.dev) - Open - ⏳ Clean up infrastructure of old docs builder - Open
Team & Ownership
Maintained by: Axel Tetzlaff / UAS Team
For questions, contributions, or access issues, reach out to the UAS team.