PDFCLOUD-5582 Initial documentation#24
Merged
datalogics-cgreen merged 9 commits intopdfrest:mainfrom Feb 13, 2026
Merged
Conversation
…ration - Added `mkdocs`, `mkdocs-material`, and `mkdocstrings[python]` to dependencies to enable documentation generation. - Updated `uv.lock` to include all new dependency versions and metadata. Assisted-by: Codex
- Created `mkdocs.yml` to configure MkDocs with Material theme and `mkdocstrings[python]` for API documentation generation. - Added `docs/` directory with the following content: - `index.md`: Home page for the documentation. - `getting-started.md`: Instructions for setup and local development. - `api-reference.md`: API reference generated from Python docstrings. - Updated `README.md` with instructions for running and building the docs site. Assisted-by: Codex
- Introduced `.github/workflows/docs.yml` to automate documentation deployment to GitHub Pages. - Configured workflow to trigger on `push` to `main` and manual dispatch. - Added build and deploy steps: - Installed dependencies with `uv` and built documentation using MkDocs. - Uploaded built files as an artifact and deployed to GitHub Pages. Assisted-by: Codex
- Added `PyDocumentationSettings` configuration in `.idea/pdfrest-python.iml`. - Set default docstring format to Google style for improved consistency with Python documentation standards. Assisted-by: Codex
- Added a new `docs-check` job to `.github/workflows/test-and-publish.yml`: - Configures dependency management with `uv` and caches dev dependencies. - Synchronizes project dependencies using `uv sync`. - Builds documentation using MkDocs with strict mode. - Updated `publish` job to depend on `docs-check`. Assisted-by: Codex
- Enabled `content.code.copy` feature in the Material theme to add a copy button for code snippets. - Added `pymdownx.tabbed` Markdown extension with alternate styling for a more interactive and polished tabbed interface. Assisted-by: Codex
- Replaced the basic dependency installation instructions with a step-by-step Cloud-first onboarding guide for `pdfrest`. - Introduced examples for using `uv`, `pip`, and `Poetry` to set up the SDK. - Added API key export instructions and a `quickstart.py` sample program for testing the text extraction feature. - Enhanced reference sections with links to the official Cloud onboarding flow, API lab, and Python API reference. - Updated the `index.md` to provide a clearer overview of `pdfRest` and its relationship to the Python SDK. - Adjusted `.pre-commit-config.yaml` to exclude `docs/` from the `mdformat` hook. Assisted-by: Codex
- Eliminated unnecessary `id-token`, `contents`, `packages`, and `pull-requests` permissions from the `docs-check` job in `.github/workflows/test-and-publish.yml`. - Simplified the workflow configuration by retaining only required steps. Assisted-by: Codex
- Clarified the distinction between contributor notes in the root directory (`README.md`, `AGENTS.md`) and site documentation in the `docs/` folder. - Documented the addition of the `Docs` CI workflow for building and deploying the documentation site via GitHub Pages. - Updated workflow descriptions to reflect current CI processes. Assisted-by: Codex
datalogics-cgreen
approved these changes
Feb 13, 2026
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
2 participants
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.
PDFCLOUD-5582
Summary
This PR introduces a docs foundation that makes project documentation a first-class, continuously validated deliverable. It establishes a Markdown-first authoring flow, automatic API reference generation from Google-style docstrings, and a publish path to GitHub Pages after merges.
New Capabilities
main.Why This Helps
Outcomes