docs: refresh README and add Sphinx/ReadTheDocs documentation portal#45
Merged
falseywinchnet merged 1 commit intoJun 23, 2026
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.
Motivation
documentation/folder.Description
README.mdinto a concise library-style guide covering features, requirements, build (Make/CMake), install, package discovery, quick-start examples, concepts, examples/probes, and documentation pointers.documentation/includingindex.md,README.md,installation.md,quick-start.md,concepts.md,examples.md,readthedocs-setup.md,contributing.md, and API reference pagesapi-c.md,api-cpp.md, andapi-bodft.mddocumenting public types, plan lifecycle, transforms, layout conversion, and residue filters.documentation/conf.py,documentation/requirements.txt, anddocumentation/.readthedocs.yaml(RTD config). The docs usemyst-parserand thefurotheme and are organized for easysphinx-buildand ReadTheDocs integration.bfft::bodft) and made an explicitquick-startC example return-path fix so it is idiomatic and complete.Testing
make testwhich built the library and tests and executed the test binaries; output:correctness ok backend=avx2-fma-256andc api ok backend=avx2-fma-256 policy=fused-scatter-plus-layout-convert(tests passed).git diff --checkto ensure no whitespace/patch issues and it returned clean results.python3 -m pip install -r documentation/requirements.txt && sphinx-build -W -b html documentation documentation/_build/html, but the environment failed to install Sphinx due to package index access returning403 Forbidden, sosphinx-buildcould not be run in this environment.Codex Task