Add API-doc site, format gate, recipe.yaml, bench - #3
Merged
Conversation
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.
Rolls the suite-wide quick wins proven on mojo-xml and mojo-feed onto this repo:
mojo formatpass oversrc/,test/,examples/(onlyexamples/list_archive.mojochanged).mojo format-clean; fix locally withpixi run fmt.docs/render_api.py(copied from mojo-xml) rendersmojo docJSON to a self-contained HTML page;docs.yamlworkflow builds and deploys it to GitHub Pages;pixi run docsbuilds it locally.mojopin (same pattern as mojo-xml; not wired to CI).bench/bench_read.mojotimes the core read path (open_tar: header parse + member iteration) over the repo's owntest/data/*.tarfixtures. Fixtures are tiny (10 KiB), so each is parsed 5000x per measurement; the bench only reads trusted in-repo fixtures and adds no parsing logic. Localpixi run benchonly, not in CI.fmt,docs,bench;.gitignorecovers generated docs and the bench binary.src/tar/__init__.mojonow starts capitalized (mojo docemits no summary warning).Local verification:
pixi run test38/38 pass;pixi run docswritesdocs/api.html; bench compiles and runs;pixi run fmt && git diff --exit-codeclean.🤖 Generated with Claude Code