This change is the result of running hyde --hyde-update on each header file in stlab.
The only interesting code change is to generate_docs.sh, which has been renamed to validate_docs.sh (updates can now be done with a -u flag).
A good effort was made to preserve as much of the existing documentation history as possible. The protocol was as follows:
Run hyde --hyde-update on a single header to get a sense for the change.
If the generated documentation referred to components not yet documented, skip to step 8.
Identify the file moves, and update the script renames.sh used exclusively for this work. See commit 422f9fcf as an example.
Revert the changes with git checkout -- docs && git clean -fxd docs
Run renames.sh to move the old documentation to the locations they would have been at had they been generated by a modern version of Hyde.
Commit this change
Rerun hyde --hyde-update
Manually fix up YAML changes as needed, often adding fields like owner.
Commit this change.
This PR does not attempt to fill in __MISSING__ fields for components not yet documented; this PR only rearranges the existing documentation to be consistent with what Hyde's latest version expects. Consequently, this PR is not sufficient for CI enforcement of documentation completeness; we need to complete the documentation first.
This change is the result of running
hyde --hyde-updateon each header file instlab.The only interesting code change is to
generate_docs.sh, which has been renamed tovalidate_docs.sh(updates can now be done with a-uflag).A good effort was made to preserve as much of the existing documentation history as possible. The protocol was as follows:
hyde --hyde-updateon a single header to get a sense for the change.renames.shused exclusively for this work. See commit 422f9fcf as an example.git checkout -- docs && git clean -fxd docsrenames.shto move the old documentation to the locations they would have been at had they been generated by a modern version of Hyde.hyde --hyde-updateowner.This PR does not attempt to fill in
__MISSING__fields for components not yet documented; this PR only rearranges the existing documentation to be consistent with what Hyde's latest version expects. Consequently, this PR is not sufficient for CI enforcement of documentation completeness; we need to complete the documentation first.