chore(repository): improve documentation and CI - #126
Merged
Conversation
Use the toolchain files as the version source of truth, add a compiled polynomial functor example, and link the generated API documentation.
Remove the unused automatic PR summary, publish doc-gen4 output from main, pin external actions to full commit hashes, reduce CI permissions, and run style linting on every pull request.
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.
Summary
This PR improves repository maintenance and makes PolyFun easier to use.
It:
lean-toolchainandlakefile.tomlas the version sources of truth;Diff metadata
31216a8f561d4259a5845a933e6e8b6c2e3d5e89(main)00e782dc2818b78c57beb41cd308fd7452658573Motivation
The repository documentation named three obsolete dependency versions. The automatic PR summary also ran on every pull request only to report that its missing key caused it to skip. Public declarations had no searchable API site, and several action dependencies used mutable version tags.
Change overview
docgen-actionpublishes frommainmainAPI documentation
.github/workflows/docs.ymlbuilds PolyFun and publishes doc-gen4 output after pushes tomain. GitHub Pages has been enabled with GitHub Actions as its deployment source. The generated API will be available at https://verified-zkevm.github.io/PolyFun/docs/ after this PR merges and the first deployment succeeds.Workflow security
All external actions now use immutable commit hashes with readable version comments. The normal build job no longer receives issue or pull request write access. The on-demand
/reviewworkflow remains restricted to comments from repository owners, members, or collaborators.Tracked follow-up work
Validation completed at
00e782dThe following passed:
lake env lean /tmp/PolyFunReadmeExample.leanpython3 ./scripts/check-docs-integrity.py./scripts/check-imports.shactionlintgit diff --check./scripts/validate.sh --lint --test, including 2,010 library build jobs and 2,056 test build jobsThe first GitHub Pages deployment can run only after the documentation workflow reaches
main.Breaking changes
There are no Lean API or dependency changes.
Reviewer map
Suggested review order:
.github/workflows/docs.yml.github/workflows/ci.ymland.github/workflows/linting.ymlsummary.ymlREADME.md,AGENTS.md, and the wiki changes