mirror of https://github.com/ankitects/anki.git synced 2026-10-19 06:19:40 +08:00

Files

T

History

wofiporiaandAbdo e6fefb2962 docs: improve manual translation instructions (#5519 )

## Linked issue (required)

Fixes #5510

## Summary / motivation (required)

Expands the manual translation instructions as requested in #5510:

- `docs-site/translators/anki/manual.mdx` now contains detailed
instructions for translating the documentation: forking the repository,
working in a language subdirectory (existing or new), keeping Markdown
formatting intact while translating the MDX pages, registering
translated pages in `docs.json` (with an example following the shape of
the existing language entries), and submitting a PR. It also notes that
partial translations are welcome, that documentation changes are
licensed under CC BY-SA 4.0, and where to ask questions.
- The Translations section of `docs-site/README.md` now links to that
page instead of holding the details itself, reversing the previous
direction per the issue.
- The Translations sections of `docs-site/developers/contributing.mdx`
and the cog-generated `docs/contributing.md` briefly mention
documentation translations, which were previously only covered for
interface strings.

Also adds myself to the CONTRIBUTORS file in a separate commit, as
requested for first pull requests.

## Steps to reproduce (required, use N/A if not applicable)

N/A

## How to test (required)

Documentation-only change. Verified that:

- All paths referenced in the new instructions exist in the repository
(e.g. `docs-site/ru/manual/`, `docs-site/manual/`, and the other
language subdirectories).
- The `docs.json` example matches the structure of the existing language
entries under `navigation.languages`.
- Both internal links resolve to pages registered in
`docs-site/docs.json` (`/translators/anki/manual`,
`/translators/anki/developers`).
- No MDX-special characters (`{`, `<`) appear outside fenced code blocks
in the new content, so `mintlify validate` should pass.
- `docs/contributing.md` stays in sync with
`docs-site/developers/contributing.mdx` under the transformation in
`docs/cogdocs.py`.

### Checklist (minimum)

- [ ] I ran `./ninja check` or an equivalent relevant check locally.
*Not applicable for a documentation-only change; the relevant check is
the Docs Site workflow (`mintlify validate` / `mintlify a11y`), which
runs in CI.*
- [ ] I added or updated tests when the change is non-trivial or
behavior changed.
*N/A - documentation-only changes are exempt from tests per
`contributing.md`.*

## Before / after behavior (optional)

N/A

## UI evidence (required for visual changes; otherwise N/A)

N/A

## Scope

- [x] This PR is focused on one change (no unrelated edits).

---------

Co-authored-by: Abdo <abdo@abdnh.net>

2026-09-22 12:06:56 +03:00

addons

fix: prefer packaged add-on name for AnkiWeb installs (#5362 )

2026-09-13 19:04:57 +03:00

ankimobile

Add translation support for docs website (#5052 )

2026-06-22 18:54:01 +03:00

feat: Docs converter (#5483 )

2026-09-10 15:10:22 +01:00

de/manual

Add translation support for docs website (#5052 )

2026-06-22 18:54:01 +03:00