add module-level doc comments and update doc generation workflow - #65
Merged
Conversation
0xTitan
force-pushed
the
update-docs-2.16.1
branch
from
March 4, 2026 21:26
67ece7f to
4c1406b
Compare
Add //! doc comments to all 15 package lib.cairo files so scarb doc generates meaningful package descriptions. Update mdbook.yml workflow to use scarb doc via generate_doc.sh instead of the old static site. Fix sed compatibility for Linux CI (GNU sed vs BSD sed).
0xTitan
force-pushed
the
update-docs-2.16.1
branch
from
March 4, 2026 21:55
1a1c3d6 to
cb67228
Compare
ermvrs
approved these changes
Mar 5, 2026
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
2 participants
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.
Pull Request type
What is the current behavior?
Package landing pages in the generated documentation (via
scarb doc) are blank because nolib.cairofiles have//!module-level doc comments. The CI workflow (mdbook.yml) deploys an outdated,manually-curated static site from
docs/website/instead of the auto-generated API docs.Issue Number: N/A
What is the new behavior?
//!module-level doc comments to all 15 packagelib.cairofiles (ascii, btc, bytes, data_structures, encoding, evm, json, linalg, math, merkle_tree, numeric, searching, sorting, storage,utils)
mdbook.ymlworkflow to install scarb and runscripts/generate_doc.shinstead of building the old static sitedocs/book.tomlanddocs/intro.mdused by the doc generation script as custom intro page and book configurationDoes this introduce a breaking change?