Add documentation pages#31
Open
karamouche wants to merge 10 commits into
Open
Conversation
📝 WalkthroughWalkthroughThe PR adds a MkDocs documentation site with new guides, references, custom styling, CI validation, and GitHub Pages deployment. It also updates documentation links, generated step-reference paths, project metadata, and contributor setup instructions. ChangesDocumentation site
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant GitHubActions
participant MkDocs
participant GitHubPages
GitHubActions->>MkDocs: install docs dependencies and run strict build
MkDocs-->>GitHubActions: produce site artifact
GitHubActions->>GitHubPages: upload and deploy site artifact
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/stylesheets/gladia.css (1)
31-33: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueUse lowercase for unquoted font family names.
Static analysis tools flag
BlinkMacSystemFont,Helvetica, andArialbecause standard CSS conventions prefer lowercase for unquoted font keywords to avoid case-sensitivity issues in certain parsers.♻️ Proposed fix
- --gladia-font-sans: "Suisse Intl", -apple-system, BlinkMacSystemFont, "Segoe UI", - Helvetica, Arial, sans-serif; + --gladia-font-sans: "Suisse Intl", -apple-system, blinkmacsystemfont, "Segoe UI", + helvetica, arial, sans-serif;🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/stylesheets/gladia.css` around lines 31 - 33, Update the --gladia-font-sans font stack to use lowercase for the unquoted family names BlinkMacSystemFont, Helvetica, and Arial, while preserving the existing font order and quoted names.Source: Linters/SAST tools
docs/contributing/index.md (1)
25-29: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse strict mode for the documented MkDocs validation command.
At Line 28, change
uv run mkdocs buildtouv run mkdocs build --strictso contributors locally validate the same broken-link and configuration constraints required by this PR.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/contributing/index.md` around lines 25 - 29, Update the documented MkDocs validation command in the contributing instructions from “uv run mkdocs build” to use the “--strict” option, ensuring local builds enforce the same broken-link and configuration checks.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/docs.yml:
- Around line 17-20: Restrict workflow-level permissions to contents: read, then
add pages: write and id-token: write under the deploy job’s permissions. Leave
the build job without these elevated permissions while preserving the deploy
job’s required access.
---
Nitpick comments:
In `@docs/contributing/index.md`:
- Around line 25-29: Update the documented MkDocs validation command in the
contributing instructions from “uv run mkdocs build” to use the “--strict”
option, ensuring local builds enforce the same broken-link and configuration
checks.
In `@docs/stylesheets/gladia.css`:
- Around line 31-33: Update the --gladia-font-sans font stack to use lowercase
for the unquoted family names BlinkMacSystemFont, Helvetica, and Arial, while
preserving the existing font order and quoted names.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 617da605-67f8-4fc5-be9b-3628d10f8622
⛔ Files ignored due to path filters (5)
docs/assets/favicon.svgis excluded by!**/*.svgdocs/assets/fonts/GeistMono-Regular.woff2is excluded by!**/*.woff2docs/assets/logo.svgis excluded by!**/*.svgdocs/assets/symbol.svgis excluded by!**/*.svguv.lockis excluded by!**/*.lock
📒 Files selected for processing (22)
.github/workflows/ci.yml.github/workflows/docs.yml.gitignoreAGENTS.mdCONTRIBUTING.mdREADME.mddocs/concepts.mddocs/contributing/guide.mddocs/contributing/index.mddocs/getting-started.mddocs/index.mddocs/languages.mddocs/presets.mddocs/reference/steps.mddocs/stylesheets/gladia.cssdocs/usage/cli.mddocs/usage/python.mdmkdocs.ymloverrides/main.htmloverrides/partials/logo.htmlpyproject.tomlscripts/generate_step_docs.py
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.
What does this PR do?
Adds Gladia-branded MkDocs documentation with GitHub Pages deploy, custom theme/styles, and reorganized docs.
Type of change
How was this tested?
Note
Low Risk
Documentation, theme assets, and CI-only changes; no runtime normalization logic is modified.
Overview
Introduces a Gladia-branded MkDocs Material documentation site (
mkdocs.yml,docs/**,overrides/, custom CSS/assets) covering getting started, concepts, usage (Python/CLI), presets, languages, generated step reference, and contributing guides.CI/CD: Adds a
docsjob toci.yml(uv sync --group docs,mkdocs build --strict) and a path-filtereddocs.ymlworkflow that builds and deploys to GitHub Pages onmain.Tooling & links: New
docsdependency group inpyproject.toml, PyPIDocumentationURL,site/in.gitignore, andgenerate_step_docs.pynow defaults todocs/reference/steps.md. README,CONTRIBUTING.md, andAGENTS.mdpoint at the published site and reorganized paths (contributing/guide.md).Docs content tweaks: Norwegian (
no) appears in supported-language tables; sample preset YAML no longer lists redundantnormalize_whitespacesteps.Reviewed by Cursor Bugbot for commit 3467213. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
no) to the supported language list.