Tech docs zensical

[Ishankoradia]

Summary by CodeRabbit

• Documentation

  • Comprehensive technical docs published with architecture overview, diagrams, feature guides (including user management & RBAC), API and developer guides, and contributing instructions.
  • Added site configuration, build instructions, and ignore rules for doc build artifacts and environments.

• Chores

  • Automated documentation build and deployment pipeline added for continuous publishing to GitHub Pages.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a documentation site and CI workflow: new GitHub Actions workflow to build and deploy docs to GitHub Pages, plus zensical/pyproject configs, .gitignore, and initial documentation content (index, contributing, user-management, README).

Changes

Cohort / File(s)	Summary
CI/CD Documentation Workflow ​.github/workflows/docs.yml	New GitHub Actions workflow "Deploy Documentation" with build and deploy jobs: checkout, Python 3.11, install uv, sync/install docs deps, build site with zensical, upload artifact, then deploy to GitHub Pages via actions/deploy-pages@v4.
Documentation Configuration ​docs/pyproject.toml, ​docs/zensical.toml	New Python project metadata and zensical site config: project name, Python >=3.10, zensical dependency, site metadata, docs/site dirs, theme and repo/edit links.
Docs Ignore & Local Setup ​docs/.gitignore, ​docs/README.md	Adds ignore rules for build outputs, venvs, caches, OS/IDE files; README with prerequisites, install, serve/build commands, and project layout.
Documentation Content ​docs/docs/index.md, ​docs/docs/contributing.md, ​docs/docs/features/user-management.md	Adds site content: project overview/architecture (including diagrams), contributing guide with service/setup instructions, and user-management feature documentation.
Minor Codestyle/Formatting Edits ​ddpui/core/charts/charts_service.py, ​ddpui/schemas/chart_schema.py	Small formatting changes (string quoting and multiline type annotation/tuple formatting); no behavioral/API changes.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Dev as Developer (push/PR)
    participant GH_Actions as GitHub Actions Runner
    participant Repo as Repository (code + docs)
    participant Artifact as Actions Artifact Storage
    participant Pages as GitHub Pages

    Dev->>Repo: push to main / open PR touching docs
    Repo-->>GH_Actions: trigger docs.yml workflow
    GH_Actions->>GH_Actions: build job: checkout, setup Python, install uv, uv sync, zensical build -> produce `docs/site`
    GH_Actions->>Artifact: upload `docs/site` artifact
    GH_Actions-->>GH_Actions: deploy job (after build completes) downloads artifact
    GH_Actions->>Pages: deploy site via actions/deploy-pages@v4
    Pages-->>Dev: provide deployed site URL (workflow output)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• Moving to uv #1002: Adds uv usage in GitHub Actions workflows (install/sync/run), matching this PR's CI approach for docs build.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'Tech docs zensical' accurately reflects the main changes, which add comprehensive technical documentation infrastructure using the Zensical documentation tool.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In @.github/workflows/docs.yml:
- Around line 28-31: The workflow uses actions/setup-python@v4 which relies on
deprecated Node 16; update the GitHub Action reference for actions/setup-python
to a supported major version (preferably `@v6`, or at minimum `@v5`) in the docs
workflow so the runner uses a supported Node runtime; locate the setup step
referencing "actions/setup-python" and change the version suffix from "@v4" to
"@v6" (or "@v5") and keep the existing python-version input intact.

In `@docs/docs/contributing.md`:
- Around line 115-121: Update the documented Sentry env defaults so
SENTRY_SEND_DEFAULT_PII is set to False by default; locate the SENTRY settings
block and change the example value for the SENTRY_SEND_DEFAULT_PII variable from
True to False and add a brief note or comment advising that this should only be
enabled after privacy/GDPR review and explicit scrubbing rules are implemented.

In `@docs/zensical.toml`:
- Around line 3-5: The site_description value contains a typo
("docs_dirocumentation"); update the string assigned to site_description to read
"Dalgo architecture and system docs_documentation" (or better "Dalgo
architecture and system documentation") by editing the site_description entry so
the value correctly spells "documentation".

🧹 Nitpick comments (1)

docs/.gitignore (1)

1-10: Align the output-dir comment with the configured site_dir.
The current note suggests the output directory is unknown, but the config sets it. Consider simplifying to avoid mixed guidance.

♻️ Suggested edit

-# The default output directory is not specified in the initial documentation,
-# but can be configured with the 'site_dir' option in the config file.
-# You will need to add the specific directory name configured in your project.
-# Common names might be 'site/', 'build/', or 'public/'.
-# Example:
+# Zensical output directory (configured via `site_dir` in docs/zensical.toml)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.64%. Comparing base (94e4892) to head (3da843e).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1233      +/-   ##
==========================================
+ Coverage   56.61%   57.64%   +1.02%     
==========================================
  Files         100      100              
  Lines       13127    13334     +207     
==========================================
+ Hits         7432     7686     +254     
+ Misses       5695     5648      -47     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.