TypeType-Video/Docs-TypeType
Watch
1
0
Fork
You've already forked Docs-TypeType
 0
mirror of https://github.com/TypeType-Video/Docs-TypeType.git synced 2026-09-22 19:16:51 +00:00
Code Issues Projects Releases Packages Wiki Activity
Documentation for the TypeType ecosystem https://typetype-video.github.io/Docs-TypeType/
82 commits 3 branches 0 tags 15 MiB
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Priveetee 7564d17b66 ci: route workflows to CI stack
2026-09-19 10:18:38 +02:00
.github ci: route workflows to CI stack 2026-09-19 10:18:38 +02:00
assets chore: add branding assets 2026-06-22 17:49:24 +02:00
docs docs: make the Dockge section credit an explicit callout 2026-09-18 11:05:42 +02:00
.gitignore chore: add project scaffold 2026-06-22 17:39:22 +02:00
.typos.toml docs: document self-hosting resource requirements 2026-07-29 16:52:18 +02:00
bun.lock perf: lazy load Mermaid diagrams 2026-07-29 15:43:54 +02:00
CODE_OF_CONDUCT.md docs: add code of conduct 2026-06-22 17:53:34 +02:00
CONTRIBUTING.md docs: add project architecture reference 2026-07-21 11:52:44 +02:00
LICENSE docs: add license and contributing guide 2026-06-22 17:49:24 +02:00
package.json perf: lazy load Mermaid diagrams 2026-07-29 15:43:54 +02:00
README.md docs: move AI transparency notice 2026-09-18 10:56:57 +02:00

README.md

TypeType

You want to know the current position of TypeType about AI ? Go check this.

TypeType Documentation

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.

Documentation sections

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.

Development

Requirements:

  • Bun
bun install
bun run docs:dev

The local documentation server starts at http://localhost:5173.

Build and preview the production site with:

bun run docs:build
bun run docs:preview

Project structure

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.

License

TypeType Documentation is licensed under the MIT License.