Repository navigation
general docs improvements - #700
Merged
Merged
Conversation
ctz
approved these changes
Oct 26, 2026
cpu
force-pushed
the
ci/cpu-docs-coverage
branch
from
October 26, 2026 15:47
99ab0ff to
b5d298e
Compare
Make references to public C API items consistent and render them as links in the generated website. Teach docgen about enum variants and type aliases, and reject backticked C API names that cannot be resolved. This makes renamed or misspelled references fail CI instead of silently producing broken documentation.
This avoids an identifier like `rustls_server_config_builder_build` being soft line-wrapped across multiple lines.
Try to connect up a few more common workflows across functions/types.
Zola 0.22 moved syntax highlighting under [markdown.highlighting], and 0.23 replaced Tera v1 macros and imports with Tera v2 components. Update the configuration, templates, and CI pin together so the site builds with the current release. Co-authored-by: Codex <noreply@openai.com>
cpu
force-pushed
the
ci/cpu-docs-coverage
branch
from
October 26, 2026 16:56
b5d298e to
c422d08
Compare
cpu
enabled auto-merge (rebase)
October 26, 2026 16:57
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A handful of general doc improvements. Recommend reviewing commit-by-commit. At a high level this branch: