docs: consolidate doc trees into mkdocs site, remove stale sdk/docs#140
Merged
Conversation
The SDK shipped two divergent doc trees: the published mkdocs site (docs/) and a pdoc-era tree (sdk/docs/) that had drifted out of sync, including a set_many() example that passed a dict instead of a list of FieldUpdate objects. Both READMEs linked to the stale tree. Pick docs/ (mkdocs) as the single canonical tree: - Migrate the async usage guide into docs/guide/async.md, fixing the stale set_many() dict example to use FieldUpdate and updating cross links to match the mkdocs nav structure. (The configuration/error handling content in sdk/docs/ was superseded by the more accurate guide/connect.md, which already documents check_version, RESOURCE_EXHAUSTED retries, and TimeoutError, so it was dropped rather than migrated.) - Add the new guide to mkdocs.yml's nav and cross-link it from docs/index.md and docs/guide/watch.md. - Remove sdk/docs/ entirely, along with the pdoc wiring that generated its stale sdk/docs/api/*.html (Makefile `docs` target, the pdoc dependency in build/Dockerfile.tools and sdk/pyproject.toml, and the matching .gitignore entry). The Makefile `docs` target now builds the mkdocs site directly, matching what .github/workflows/docs.yml does. - Repoint README.md and sdk/README.md documentation links at the published docs site (opendecree.github.io/decree-python) instead of the removed sdk/docs/ tree, and update CLAUDE.md's tooling table. Closes #135
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
docs/) and a pdoc-era tree (sdk/docs/) — that had drifted out of sync, including aset_many()example that passed adictinstead of a list ofFieldUpdateobjects. BothREADME.mds linked to the stale tree, so users following the published links could land on outdated, incorrect content.docs/) removes the drift risk going forward and ensures the docs users see from the README and the API reference stay in sync.What changed
docs/guide/async.md, fixing the staleset_many()dict example to useFieldUpdate(verified against the actualset_manysignature insdk/src/opendecree/client.py/async_client.py) and updating cross-links to match the mkdocs nav. The configuration/error-handling content insdk/docs/was not migrated as-is — it was superseded by the more accuratedocs/guide/connect.md, which already documentscheck_version,RESOURCE_EXHAUSTEDretries, andTimeoutError(things the oldsdk/docs/configuration.mdwas missing).mkdocs.yml's nav and cross-linked it fromdocs/index.mdanddocs/guide/watch.md.sdk/docs/entirely, including the pdoc wiring that generated its stalesdk/docs/api/*.html(the Makefiledocstarget, thepdocdependency inbuild/Dockerfile.toolsandsdk/pyproject.toml, and the matching.gitignoreentry). The Makefiledocstarget now builds the mkdocs site directly, matching.github/workflows/docs.yml.README.mdandsdk/README.mddocumentation links at the published docs site (opendecree.github.io/decree-python) instead of the removedsdk/docs/tree, and updatedCLAUDE.md's tooling table (pdoc→mkdocs).Test plan
make lint— ruff check + format check passmake typecheck— mypy passes (29 source files, no issues)make test— 298 passed, 13 skipped, 100% coveragemkdocs build --strict— succeeds with no broken-link warnings, andsite/guide/async/renders correctly alongsideconnect/andwatch/sdk/docsandpdocconfirms no remaining referencesCloses #135