Commit 7db408b
authored
docs: migrate to MkDocs Material, apply Redis branding, restore Diataxis README (#28)
* Migrate documentation from Sphinx to MkDocs Material
- Replace Sphinx + sphinx-book-theme with MkDocs + Material theme
- Use mkdocstrings to auto-generate API reference from Google-style docstrings
- Auto-generate llms.txt and llms-full.txt via mkdocs-llmstxt plugin
- Convert MyST admonitions and {doc} cross-refs to Material syntax and relative links
- Convert sphinx-design grid cards to Material grid cards on landing pages
- Move Redis AI Hub header CSS/JS to docs/stylesheets and docs/javascripts
- Update pyproject.toml docs group, Makefile targets, and .readthedocs.yaml
- Remove docs/conf.py, docs/Makefile, docs/llms.txt (now auto-generated), docs/SPEC.md
- Add site/ to .gitignore
* docs: apply Redis branding, drop AI Hub header, restore Diataxis README
Branding:
- Switch Material primary/accent to the official Redis red (#FF4438)
via `docs/stylesheets/redis-brand.css` overriding `--md-primary-fg-color`
and `--md-accent-fg-color`.
- Adopt the Redis font pair: Space Grotesk (body) and Space Mono (code),
matching `redis-docs/tailwind.config.js`.
- Replace the default Material book icon with the cursive `redis` script
wordmark (white) in the header (`docs/assets/redis-logo-script.svg`).
- Use `Redis_Favicon_32x32_Red.png` from redis-vl-python as the browser
favicon (`docs/assets/favicon.png`).
- Bold every top-level entry in the left sidebar so single-page items
(Home) match the section-header weight given by `navigation.sections`.
Independent site:
- Remove the Redis AI Hub header injection
(`docs/javascripts/redis-ai-hub-header.js` and the matching CSS).
This site stands on its own; it is no longer embedded under the hub
chrome.
- Drop the now-empty `docs/javascripts/` directory.
- Slim the stylesheet from 217 lines to 39 and rename it to
`redis-brand.css` to reflect what it now contains.
README:
- Restore the comprehensive content (TEXT search modes, IS NULL /
ismissing, exists(), DATE/DATETIME handling, date functions, full GEO
feature catalog, design rationale, architecture diagram).
- Reorganize along Diataxis tiers: Tutorial then Reference then How-to
then Explanation then practical sections.
- Note that docs.redisvl.com/projects/sql-redis/ is not yet live and
point readers to `make docs-serve` for local previews.
- Keep the recent improvements (`pip install`, `create_executor()`
factory, `make install/test/lint`, AI Hub status note).
For-AI-agents audit:
- Replace stale Sphinx references (`autoclass`, `sphinx-build -W`) with
their MkDocs equivalents (`mkdocstrings`, `mkdocs build --strict`) in
`AGENTS.md`, `docs/for-ais-only/index.md`, and
`docs/for-ais-only/BUILD_AND_TEST.md`.
`mkdocs build --strict` passes.1 parent d19a0c9 commit 7db408b
42 files changed
Lines changed: 1611 additions & 1215 deletions
File tree
- docs
- api
- assets
- concepts
- examples
- for-ais-only
- stylesheets
- user_guide
- how_to_guides
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
| 58 | + | |
58 | 59 | | |
59 | 60 | | |
60 | 61 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
25 | | - | |
| 24 | + | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
96 | 96 | | |
97 | 97 | | |
98 | 98 | | |
99 | | - | |
100 | | - | |
| 99 | + | |
| 100 | + | |
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
110 | | - | |
| 110 | + | |
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | | - | |
| 54 | + | |
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
59 | | - | |
| 58 | + | |
60 | 59 | | |
61 | 60 | | |
62 | 61 | | |
| |||
69 | 68 | | |
70 | 69 | | |
71 | 70 | | |
| 71 | + | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
| |||
0 commit comments