No description
Find a file
2024-02-06 21:52:08 +01:00
.github/workflows targets 2024-02-06 21:29:09 +01:00
src docs 2024-02-06 21:52:08 +01:00
targets stuff 2024-02-06 18:46:43 +01:00
.gitignore deploy 2024-02-06 20:24:20 +01:00
Cargo.lock things 2024-02-06 20:20:51 +01:00
Cargo.toml things 2024-02-06 20:20:51 +01:00
README.md Update README.md 2024-02-06 21:35:40 +01:00
target_info.toml things 2024-02-06 20:20:51 +01:00

target tier docs experiment

Experiment with automatically generating target tier docs.

View the deployment on https://nilstrieb.github.io/target-tier-docs-experiment/

Problems

Currenly, the target tier docs are hard to navigate. If you want to find information about a specific target, you first need to do some glob-search yourself and then also hope that the target actually exists. This is super annoying (:(). Additionally, some targets are completely missing and there is no reason to believe that the documentation won't suddenly start being out of date. Pages are also inconsistent about which sections exist and which ones don't.

Solution

Enter: adding yet another preprocessing step.

By adding yet another preprocessing step, we can solve all these problems.

  • Have a dedicated page for every single target including information about maintainers etc. This makes it super easy to find things when there are problems.
  • Ensure that no target is completely undocumented, at least having a stub page pointing out the undocumentedness
  • Error when there is documentation that is not needed anymore, for example a removed target
  • Still keep the nice and easy-to-organize glob structure in the source
  • Use a unified structure for all the pages
  • This also allows us to put more dynamic values into the docs. For example, I put --print cfg there, isn't that pretty!?