mirrors/anki
2
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2026-09-10 07:29:19 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
dependabot/uv/gitpython-3.1.59
anki/docs/ninja.md
Luc Mcgrady 7cf1d29896 docs: Replace docs/ with symlinks (#5031) 
<!--
Title (for the Pull Request title field at the top):
Use a short prefix so the change type is obvious. You do not need to
repeat it in the body below.

Examples:
- fix: — bugfix
- feat: — feature
- refactor: — internal change without user-facing feature
- docs: — documentation only
- chore: — tooling, CI, deps, build housekeeping
- test: — tests only
-->

## Linked issue (required)

<!-- Fixes #123 / Closes #123 / Refs #123 -->
closes #5001

This PR replaces the contents of `docs/` with symlinks to
`docs-site/developers/`

A caveat of this is that the metadata appears at the top of the file
instead of the title.
<img width="885" height="275" alt="image"
src="https://github.com/user-attachments/assets/430f9a71-e5a5-4412-983a-e4cfd7dc4714"
/>

We could either:
- Use ninja to copy the files from docs-site/developers and convert it
from .mdx to .md (Might be a problem with the symlink approach if mdx is
added to the contributor file later)
- Leave placeholder "For contribution instructions see: (link to
mintlify site)"s in the folder, which would have to wait until the
domain of the site is set. (Probably the best solution).

---------

Co-authored-by: Abdo <abdo@abdnh.net>
2026-08-04 22:01:31 +03:00

966 B
Raw Permalink Blame History

Ninja

Brief notes for people used to the existing Bazel build system:

  • Put the ninja binary on your path: https://github.com/ninja-build/ninja/releases/tag/v1.11.1 (on Windows, if you have it installed in msys, make sure the native binary occurs earlier on the path)

  • Ensure Rust is installed via rustup: https://rustup.rs/

  • Remove the .bazel and node_modules folders from your existing checkout

  • Run with ./run

  • Run tests with './ninja check' (tools\ninja on Windows)

  • Format files with './ninja format'

  • Fix eslint/copyright issues with './ninja fix'

  • Targets are hierarchical, so './ninja check:jest:deck-options' will run the Jest tests for ts/deck-options, and './ninja check:jest' will run all Jest tests.