Repository navigation
Commit 6e09a83
committed
Split the documentation site out of the library repository
The pages, the tools that render them and the tests that check them move here from
CTRLRun/ctrlrun, with their history. That repository keeps the library, its specifications,
its README assets and everything `pip install ctrlrun` ships; this one keeps everything a
reader sees at ctrlrun.dev and nothing that is published to PyPI.
This repository is the Mintlify site root, so what was `docs/docs/` is `docs/` and the loose
pages moved up one level. Every URL and every docs.json entry is unchanged. `.mintignore` is
rewritten: the root used to be one directory with a few neighbours and is the whole repository
now, so the tooling, the tests and the form API are each named. A file that is not a page and
is not on that list would be a page nobody meant to publish.
**The guarantee that a page describes the shipped library needed both trees, so it did not
survive the split on its own.** `tools/docs_audit/_core.py` resolves a library checkout from
$CTRLRUN_SOURCE or ../ctrlrun and raises when there is none: a check that cannot find the
code is a red run, never a green one that verified nothing. CI here checks the library out;
the library's CI runs these same checks from here against the commit it is proposing, so one
implementation covers both directions.
Five of the library's test files were split rather than moved, each along a line that was
already there. What came here is the half that reads a page: the cookbook page checks, the
claims and adapter tables, T180's scan over the release documents, the verify page, and a new
comparison between this repository's images and the library's brand assets.
Four of those tests had begun skipping rather than failing once the pages moved -- each
guarded its read with a `pytest.skip("no repository checkout")` written for an sdist, where
the pages are pruned. Here the pages are never pruned, so a missing one is a failure.
One thing this commit cannot do: the Mintlify content directory is still `/docs` inside the
library's repository. It has to be repointed at this repository's root, once, in the Mintlify
dashboard, or the site keeps building from a directory with no pages left in it.1 parent d1fd484 commit 6e09a83
254 files changed
Lines changed: 1449 additions & 2324 deletions
File tree
- .github/workflows
- assets
- docs
- architecture
- compare
- concepts
- cookbook
- demos
- get-started
- guides
- mcp
- production
- reference
- api
- security
- study
- verify
- generated
- images
- scripts
- snippets
- tests
- tools/docs_audit
- website-form
- api
- public
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
169 | 169 | | |
170 | 170 | | |
171 | 171 | | |
172 | | - | |
| 172 | + | |
173 | 173 | | |
174 | 174 | | |
175 | 175 | | |
| |||
276 | 276 | | |
277 | 277 | | |
278 | 278 | | |
279 | | - | |
| 279 | + | |
280 | 280 | | |
281 | 281 | | |
282 | 282 | | |
| |||
286 | 286 | | |
287 | 287 | | |
288 | 288 | | |
289 | | - | |
| 289 | + | |
290 | 290 | | |
291 | 291 | | |
292 | 292 | | |
| |||
406 | 406 | | |
407 | 407 | | |
408 | 408 | | |
409 | | - | |
| 409 | + | |
410 | 410 | | |
411 | 411 | | |
412 | 412 | | |
| |||
415 | 415 | | |
416 | 416 | | |
417 | 417 | | |
418 | | - | |
419 | | - | |
| 418 | + | |
| 419 | + | |
420 | 420 | | |
0 commit comments