chore: bump to 0.3.6, migrate docs to openlegalstandard.org#18
Merged
Conversation
The user-facing documentation has moved from the broken folio-python.readthedocs.io site to a comprehensive 9-page reference at https://openlegalstandard.org/resources/folio-python-library/. The new site covers install, search, structured queries, taxonomy, properties and triples, serialization, LLM integration, and a full API reference, with every code snippet validated against the published wheel. This commit removes the now-redundant Sphinx infrastructure from the folio-python repo: - docs/ (entire Sphinx project, replaced by Astro) - .readthedocs.yaml (RTD build config no longer needed) - .github/workflows/publish.yml (Trusted Publisher workflow that was never configured on PyPI; releases are published locally via `uv build && uvx twine upload`) Logo moved from docs/_static/folio-logo.png to assets/folio-logo.png and the README image link updated. README documentation link now points at openlegalstandard.org. CONTRIBUTING.md adds a note that user-facing docs live in the openlegalstandard.org repo and should be updated alongside any public-API changes. Version bumps: - pyproject.toml: 0.3.5 -> 0.3.6 - folio/__init__.py: 0.3.5 -> 0.3.6 - uv.lock: self-reference 0.3.5 -> 0.3.6 Closes #14. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
1 participant
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
Migrates user-facing documentation from the broken
folio-python.readthedocs.iosite to a comprehensive 9-page reference at openlegalstandard.org/resources/folio-python-library (alea-institute/openlegalstandard.org#1), then deletes the Sphinx infrastructure from this repo.Closes #14.
Changes
Removed
docs/(Sphinx project — replaced by Astro).readthedocs.yaml(RTD build config).github/workflows/publish.yml(Trusted Publisher workflow that was never wired up on PyPI; releases are published locally withuv build && uvx twine upload)Moved
docs/_static/folio-logo.png→assets/folio-logo.pngUpdated
README.md— Documentation section now points at openlegalstandard.org with a brief description of the new sub-pages; logo image path updated to match the moved assetCONTRIBUTING.md— adds a Documentation section explaining where user-facing docs live and asking PRs that touch public API to keep them in syncVersion bump
pyproject.toml: 0.3.5 → 0.3.6folio/__init__.py: 0.3.5 → 0.3.6uv.lockself-reference: 0.3.5 → 0.3.6CHANGES.mdentry for 0.3.6Test plan
uv sync— cleanuv run pytest tests/ -k "not benchmark"— 54/54 passinguv run ruff check— clean🤖 Generated with Claude Code