mirror of
https://github.com/ankitects/anki.git
synced 2026-07-23 15:26:49 -04:00
fb0215a2c1
## Summary - add a generated `docs-site/` Mintlify proof of concept for a unified Anki docs site - migrate the desktop manual, AnkiMobile docs, FAQs, add-on docs, translation docs, release notes, legacy docs, and repo-local Sphinx/MyST developer docs into the POC tree - add a migration helper that preserves mdBook ordering, handles common MDX incompatibilities, and regenerates the landing-page-inspired Mintlify styling - apply minimal styling based on the current Anki landing page: Anki logo, Hanken Grotesk, blue primary color, subtle surfaces, and compact nav treatment ## Validation - `uv run --with ty ty check tools/mintlify_poc_migrate.py` - `source ~/.nvm/nvm.sh && nvm use 22.15.0 && mint validate` - previewed locally with `mint dev --port 3000` and checked the home page/developer docs in browser ## Notes This is intentionally a draft POC. It does not remove the existing Sphinx or mdBook docs flows yet; it demonstrates what bringing the sources into this repo and building from a single Mintlify root could look like. --------- Co-authored-by: Andrew Sanchez <andrewsanchez@users.noreply.github.com> Co-authored-by: Luc Mcgrady <lucmcgrady@gmail.com> Co-authored-by: Abdo <abdo@abdnh.net>
18 lines
289 B
Plaintext
18 lines
289 B
Plaintext
---
|
|
title: "Rust API"
|
|
---
|
|
|
|
Anki's Rust API documentation is generated from doc comments in the `rslib/`
|
|
crates using `cargo doc`.
|
|
|
|
To browse the docs locally:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
The main crates are:
|
|
|
|
- **anki** (`rslib/`) - Core library
|
|
- **anki_io** (`rslib/io/`) - I/O utilities
|