feat: API map index generator and guide - #1473
Conversation
|
Thank you for this PR, which will now be reviewed. If submitting to ./Physlib or ./QuantumInfo, please see our review guidelines if you are not familiar with the process. You should expect a back and forth with a reviewer before your PR is merged. See also that link for how to add appropriate labels to your PR. The PR will also go through a number of automated checks. You can learn more about these here, including how to run them locally. If you are submitting to ./PhyslibAlpha there will be a lighter review process, though your PR must still pass the automated checks. If you want to bring attention to this PR, please write a message on this thread of the Lean Zulip. Important: If a reviewer adds an |
f574e33 to
38401fb
Compare
There was a problem hiding this comment.
this all looks really good. But I think we should think about whether html is the correct output for this.
Maybe if we output a json or a (large) yaml file containing all of the necessary information, on the website rep we can include a page which displays that json or yaml in nice ways. I've found this approach often works better (and we should likely do that for the stats page aswell). I think the TODO list is done in this was as an example.
(I also think the html outputted would no longer be compatible with the format of the website).
|
Reworked as suggested: the HTML output is gone, and the script now emits a single YAML data file, docs/_data/APIMap.yml, mirroring the repo's existing data-file exporter pattern with the same mkFile convention and uncommitted artifact. It carries each map's path, title, overview, parents, references and requirements with completion counts and GitHub links, so the website repo can render it the same way as the task list. |
38401fb to
b308117
Compare
|
-awaiting-author |
This adds a small index generator for the API maps:
lake exe api_map_indexreads theAPI-map.yamlfiles and writesdocs/APIMap.htmlin the doc-site layout, so the existing maps are browsable in one place. A short guide for writing map entries is included atdocs/API_MAP_GUIDE.md. It complements the per-area maps being added under #1414 and picks up new ones automatically. Nothing in the repo invokes the generator yet: the site build would addlake exe api_map_indexnext to its existinglake exe stats mkHTMLstep to publish the page.