mirror of
https://github.com/zkldi/Tachi.git
synced 2026-09-27 01:20:31 +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
28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
# Contributing Overview
|
|
|
|
So, you're interested in contributing to Tachi? Awesome! All help is appreciated.
|
|
But, what *can* you contribute, and where can you help out?
|
|
|
|
## What does Tachi need?
|
|
|
|
Contrary to what you might already think, contributing to Tachi actually has remarkably little to
|
|
do with code.
|
|
|
|
The primary Tachi maintainer (henceforth referred to as `zk`, because that's their name)
|
|
deals with the core of the codebase; things like importing scores, adding new features and most of the UI work
|
|
is handled by them.
|
|
|
|
Tachi actually doesn't really have a shortage of people who can write good code, and the core of the codebase
|
|
feature-wise is maintainable entirely by `zk` comfortably.
|
|
|
|
What **isn't** possible to maintain, is the sheer amount of things going on in every game! `zk`
|
|
cannot reasonably keep track of all the games we support and everything that's going on in them.
|
|
|
|
That's where you step in - people who actually actively *play* games on Tachi! By letting `zk`
|
|
know about things going on in your game - and even contributing things yourself - you help make their life easier
|
|
and Tachi's support for your favourite game even better!
|
|
|
|
## Sounds good.
|
|
|
|
Awesome! Start with the [Setup](./setup.md) guide. This will get Tachi running on your local PC, so you can test all your changes.
|