mirror of
https://github.com/zkldi/Tachi.git
synced 2026-09-27 17:38:11 +03:00
zk
e363bd2532
* docs: migrate from mkdocs to mdbook - Rename old mkdocs docs/ to old-docs/ for reference - Set up new docs/ with mdbook (book.toml + src/ tree) - Mirror full nav structure from mkdocs.yml into SUMMARY.md - Add Justfile-docs with docs-serve, docs-build, docs-check, docs-install recipes - Import Justfile-docs from root Justfile - Rewrite .github/workflows/docs.yml: build step uses taiki-e/install-action to install mdbook, split into separate build + deploy jobs, PR builds run the check step too * ci(docs): pin actions to SHAs, install mdbook via release binary * ci(docs): install mdbook from apt instead of curling a release binary * dev: replace mkdocs python stack with mdbook in dev image * ci(docs): apt only works on Debian; restore release binary install for Ubuntu CI * docs: fix duplicate file entries in SUMMARY.md * docs: remove docs-install recipe * docs: remove site-url from book.toml to fix asset loading * dev: install mdbook from upstream release binary, not Debian apt The Debian package (0.4.x+ds) strips bundled font assets, leaving the built site without fonts/fonts.css. Use the upstream tarball (same as CI) so the theme is complete. Handles x86_64 and aarch64. * docs: vendor mdbook tarballs in dev/mdbook/, install from there Dockerfile.dev uses COPY + tar to install the right arch at build time. CI extracts the x86_64 tarball directly from the checkout. No network access required for either — and no stripped-fonts Debian package. * fix: unwritten
72 lines
2.8 KiB
Markdown
72 lines
2.8 KiB
Markdown
# Tachi Documentation
|
|
|
|
This site serves as the documentation for Tachi.
|
|
|
|
Tachi is a fully-open rhythm game score tracking engine, and is the name of the codebase that powers
|
|
both [Bokutachi](https://boku.tachi.ac) and [Kamaitachi](https://kamai.tachi.ac).
|
|
|
|
!!! help
|
|
Tachi is **fully open**. The core is almost exclusively maintained by [one person](https://github.com/zkldi).
|
|
However, we support nearly twenty games and playtypes now. Said one person cannot reasonably keep up
|
|
with all the new things coming out in those games.
|
|
|
|
If you care about a game you play a lot, and want to help out Tachi, there are loads of ways you can contribute
|
|
and ease the load on the primary maintainer!
|
|
|
|
Because Tachi is fully open source, if you want a feature, bug-fix, or new content added to your game,
|
|
you can *become a contributor* or *report to someone who will contribute!*
|
|
|
|
We maintain a **comprehensive** [contribution guide](./contributing), which is accessible
|
|
to even people who have never wrote a line of code in their life. If you want to improve Tachi, and maybe even
|
|
nab some development skills yourself (or look good on a CV!), check it out. I've put a lot of effort into it.
|
|
|
|
## About This Documentation
|
|
|
|
This is the documentation for _all_ of Tachi. It - like Tachi - is primarily maintained by one
|
|
person, and as such, some things may be slightly outdated, wrong, or generally just ill-maintained.
|
|
|
|
!!! info
|
|
If you're confused about anything, ask in your Tachi instance's discord!
|
|
We have a remarkably helpful community of developers and contributors, who should be able to help you out.
|
|
|
|
Apologies in advance! If you find a problem in the documentation, you can freely contribute a fix
|
|
to it. See the [Contribution Guide](./contributing)!
|
|
|
|
## User Wiki
|
|
|
|
This is for end user reference, such as score importing tutorials, documentation on tachi's
|
|
statistics. It requires no programming knowledge, and is mostly used as a wiki-like reference.
|
|
|
|
View it [here](./wiki).
|
|
|
|
---
|
|
|
|
## Programmer References
|
|
|
|
These sections are for experienced programmers who want to see documentation on how
|
|
Tachi's components work internally and externally.
|
|
|
|
### Contributor Reference
|
|
|
|
If you're looking to contribute to Tachi, check out the [Contribution Guide](./contributing).
|
|
|
|
### API Reference
|
|
|
|
This is for people who want to make things with Tachi's API, and assumes basic knowledge of
|
|
APIs and how they work.
|
|
|
|
View it [here](./api).
|
|
|
|
### Codebase Reference
|
|
|
|
This is for people who want further documentation for `Tachi`'s codebase.
|
|
This is mainly full of high-level architectural documentation.
|
|
|
|
View it [here](./codebase).
|
|
|
|
## Acknowledgements
|
|
|
|
This documentation is built on top of the beautiful [Material MKDocs](https://squidfunk.github.io/mkdocs-material) theme.
|
|
|
|
--8<-- "includes/abbreviations.md"
|