Improve project documentation - #7
Merged
Merged
Conversation
maveryn
marked this pull request as ready for review
July 27, 2026 05:23
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
Public metadata already updated
Validation
python -m pytest -q tests/test_docs_site.py tests/test_public_paper.py tests/test_visibility_surfaces.py— 25 passedmkdocs build --strict --site-dir site— passed573555b084a6e9e84a6b9d9c516bc2db2f10305acca49c65d7c2688a57913c40The full Windows test suite was not run to completion: its first failure is the existing symlink-privilege test (
WinError 1314), while CI runs on Ubuntu.Manual repository-setting follow-up
GitHub does not expose social-preview upload through its supported repository API. After review, upload
docs/assets/social/trace-social-preview.pngunder Settings → Social preview; the website metadata already points to the committed asset.