This repository contains the user and self-hosting documentation for the TypeType ecosystem. The site is built with VitePress and published at typetype-video.github.io/Docs-TypeType.
| Section | Audience | Contents |
|---|---|---|
| User guide | People using a TypeType instance | Watching, search, accounts, libraries, settings, privacy, and content controls |
| Self-hosting | Instance operators | Installation, configuration, authentication, reverse proxy, updates, rollback, and troubleshooting |
| Project | Contributors and integrators | Architecture, repository ownership, playback, releases, source references, and community acknowledgements |
The central TypeType repository owns the Docker Compose stack, installer, releases, and project issue tracker. This repository explains how those supported workflows are used.
Requirements:
- Bun
bun install
bun run docs:devThe local documentation server starts at http://localhost:5173.
Build and preview the production site with:
bun run docs:build
bun run docs:preview| Path | Contents |
|---|---|
docs/guide | User-facing guides |
docs/self-hosting | Installation and operator guides |
docs/project | Architecture and contributor-facing project guides |
docs/.vitepress/config.mts | Navigation, sidebars, search, and site metadata |
docs/.vitepress/theme | TypeType documentation theme |
docs/public | Screenshots, images, and public site assets |
assets | README banner and repository widgets |
Read CONTRIBUTING.md before editing the documentation. Report inaccurate or missing documentation in the central issue tracker. Community reports and discussions used as documentation sources are credited on the acknowledgements page.
TypeType Documentation is licensed under the MIT License.