|
Revision tags: dev, v36.0.9, v44.0.1, v43.0.2, v36.0.8, v24.0.8, v44.0.0, v43.0.1, v42.0.2, v36.0.7, v24.0.7, v43.0.0, v42.0.1, v41.0.4, v42.0.0, v40.0.4, v36.0.6, v24.0.6, v41.0.3, v41.0.2, v41.0.1, v36.0.5, v40.0.3, v41.0.0, v36.0.4, v39.0.2, v40.0.2, v40.0.1, v40.0.0, v39.0.1, v39.0.0, v38.0.4, v37.0.3, v36.0.3, v24.0.5, v38.0.3, v38.0.2, v38.0.1, v37.0.2 |
|
| #
97e0b7db |
| 29-Sep-2025 |
Alex Crichton <[email protected]> |
Reorganize example documentation (#11757)
* Reorganize example documentation
This commit reorganizes example documentation in our online documentation. The main changes here are:
* Chapter-per-lan
Reorganize example documentation (#11757)
* Reorganize example documentation
This commit reorganizes example documentation in our online documentation. The main changes here are:
* Chapter-per-language is now removed in favor of tabs-in-a-page for avoiding having the book be so large. Tabs are made with [mdbook-langtabs]. * Language-specific pages are all consolidated into a single page. * Language-specific documentation now only mentions where to find docs instead of trying to document an intro for each language here. * "Further examples" was folded into the main API section, meaning we just have one chapter of a lot of examples.
The main goal is to make the book less overwhelming from an example perspective and ideally make it a bit easier to discover things. The langtabs plugin is nice but not perfect, e.g. it doesn't support `#`-anchors nor remembers which language you were looking at. Overall though I feel this is still better than before.
[mdbook-langtabs]: https://github.com/nx10/mdbook-langtabs
* Fix typos
* Remove testing of mdbook from CI
show more ...
|