docs: MkDocs site, README overhaul, and GitHub Pages CI#14
Merged
Conversation
Adds a GitHub Actions workflow that builds the `mkdocs.yml` configuration with the Material theme + mkdocstrings + llmstxt plugins, then deploys to GitHub Pages via `actions/deploy-pages@v4` (OIDC, no token needed). Changes: - `.github/workflows/docs.yml`: build + deploy on push to main when any docs source changes (docs/**, mkdocs.yml, src/**, pyproject.toml, uv.lock, the workflow itself). Also supports `workflow_dispatch` for manual triggers. - `mkdocs.yml`: switch `site_url` from the unresolved `https://ai.redis.io/adk/` to the GitHub Pages canonical URL `https://redis-developer.github.io/adk-redis/`. - `pyproject.toml`: new `[docs]` optional extra so contributors can reproduce the build with `uv sync --extra docs --extra all`. The workflow uses `mkdocs build` (not `--strict`) on purpose. There are 44 pre-existing griffe docstring/signature warnings in `tools/memory/*` (the Memory* tools' docstrings document parameters that don't appear in the actual function signatures). Those warnings are real and worth fixing, but should not block doc deploys. Tracked separately. Post-merge follow-ups: - Enable GitHub Pages on the repo (`Settings > Pages > Source: GitHub Actions`) so the deploy step has an environment to push to. Can be set via API: `gh api -X POST repos/.../pages -f build_type=workflow`.
- Remove mkdocs-macros-plugin from docs extra (not used in mkdocs.yml) - Remove uv.lock from workflow paths filter (no lockfile committed) - Add branch guard (if: github.ref == 'refs/heads/main') to deploy job so workflow_dispatch from non-main branches cannot overwrite the site
- Header badge now links to redis-developer.github.io/adk-redis/ - Body links updated from relative doc paths to docs site URLs - Old redis.io docs link preserved in Helpful links section
The mkdocs site is now the primary documentation. The redis.io integration page is preserved as a secondary reference.
Now that the mkdocs docs site is live, the README serves as a storefront: what it does, install, one quick start snippet, examples list, and links to the docs site for everything else. Removed from README (now in docs site only): - Search, MCP, and semantic cache quick start snippets - Search tools breakdown (in-process vs MCP tables) - Memory backends section - Semantic cache providers section - Requirements section - Full development targets list - Detailed prerequisites and Docker commands
The site/ directory was being tracked, causing GitHub to report 88.7% HTML. Now gitignored.
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.
What
Adds a full MkDocs Material documentation site published to GitHub Pages, overhauls the README, and adds CI to deploy docs on push to
main.Documentation site
Site URL: https://redis-developer.github.io/adk-redis/
README
Slimmed from 401 to 145 lines. Keeps the capability table, install, one quick start snippet, and links to the docs site. All deep-dive content now lives in the docs site only.
CI
.github/workflows/docs.yml: builds and deploys MkDocs to GitHub Pages on push tomain.gitignore: addedsite/(was previously tracked, causing 88.7% HTML in language stats)Other fixes