Add zensical.toml configuration

[koxudaxi]

Summary by CodeRabbit

• Chores
  • Replaced the project documentation configuration with a new site setup using a Material-style theme, icons, two color palettes (light/dark), analytics, enhanced Markdown features (code highlighting, tabs, admonitions, snippets, TOC), search plugin, and an extensive navigation covering overview, CLI reference, supported data types, usage, templates, integrations, FAQ, contributing, and changelog.
  • Removed the prior documentation site configuration.

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

[coderabbitai]

Warning

Rate limit exceeded

@koxudaxi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 734519f and 59ad315.

📒 Files selected for processing (3)

• README.md (1 hunks)
• docs/index.md (2 hunks)
• zensical.toml (1 hunks)

Walkthrough

Added a new Zensical.toml site configuration and removed the existing mkdocs.yaml, moving site metadata, theme settings, Markdown extensions, plugins, analytics, and the navigation tree into the TOML file. (No code logic changes.)

Changes

Cohort / File(s)	Summary
New site configuration Zensical.toml	New TOML config added containing site metadata, repository info, Material theme settings (icons, features, two color palettes), analytics (gtag), Markdown extensions (pymdownx options: highlight, inline highlighting, snippets, superfences, tabbed, admonitions, attr_list, md_in_html, toc), plugins, and an extensive documentation navigation tree (Overview, CLI Reference, Supported data types, Usage, Templates/Formatting, Integration, FAQ, Development/Contributing, Changelog).
Removed MkDocs config mkdocs.yaml	Deleted MkDocs YAML configuration that previously declared site metadata, theme configuration, Markdown extensions, navigation structure, and plugins (search).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

• Verify nav entries in Zensical.toml match actual documentation file paths and filenames.
• Confirm theme feature flags, icon settings, and palette definitions are valid for the Material theme TOML format.
• Check Markdown extension options were translated correctly from YAML to TOML semantics.
• Validate analytics gtag, repo URLs, and other metadata formatting.
• Search the repo for any tooling or CI references still expecting mkdocs.yaml.

Poem

🐰 I nibble lines of config bright,
I tiptoe through each nav and light,
A TOML carrot, tidy, new,
I hop the docs to guide you through,
Hooray — the site feels crisp and right ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title accurately reflects the main change: adding a new Zensical.toml configuration file while removing the old mkdocs.yaml configuration.

---

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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a158041 and 7872159.

📒 Files selected for processing (1)

• Zensical.toml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

• GitHub Check: 3.11 on Windows
• GitHub Check: 3.11 on macOS
• GitHub Check: 3.9 on Windows
• GitHub Check: 3.10 on macOS
• GitHub Check: 3.10 on Windows
• GitHub Check: 3.14 on Windows
• GitHub Check: 3.13 on macOS
• GitHub Check: 3.13 on Windows
• GitHub Check: 3.12 on Windows
• GitHub Check: Analyze (python)
• GitHub Check: benchmarks

🔇 Additional comments (2)

Zensical.toml (2)

1-242: Overall configuration looks good.

The Zensical.toml configuration is well-structured with clear organization of site metadata, theme settings with light/dark mode toggle, markdown extensions, and a comprehensive navigation hierarchy. The Material theme configuration follows expected patterns.

---

42-43: Remove the concern about the Google Analytics tag format.

The gtag value "275257853" is correct for Zensical's configuration. Zensical expects an integer value for Google Analytics, not the "G-XXXXXXXXXX" format (which applies to gtag.js code implementation, not TOML config).

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

Zensical.toml (1)

22-22: Typo still present: "Support data types" should be "Supported data types".

This issue was previously flagged. The navigation title should use proper grammar.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4c8f06 and 734519f.

📒 Files selected for processing (1)

• Zensical.toml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)

• GitHub Check: CodeQL
• GitHub Check: py312-isort6 on Ubuntu
• GitHub Check: py312-pydantic1 on Ubuntu
• GitHub Check: 3.11 on Windows
• GitHub Check: py312-black23 on Ubuntu
• GitHub Check: 3.12 on Windows
• GitHub Check: 3.11 on Ubuntu
• GitHub Check: 3.9 on Ubuntu
• GitHub Check: py312-isort5 on Ubuntu
• GitHub Check: 3.10 on Windows
• GitHub Check: 3.9 on macOS
• GitHub Check: 3.9 on Windows
• GitHub Check: 3.14 on Windows
• GitHub Check: 3.12 on macOS
• GitHub Check: 3.13 on Windows
• GitHub Check: benchmarks
• GitHub Check: Analyze (python)

🔇 Additional comments (2)

Zensical.toml (2)

1-122: Well-structured configuration file.

The Zensical.toml configuration is comprehensive and well-organized, with clear sections for project metadata, navigation, theme settings, and markdown extensions. The navigation structure is logical and the theme features provide a good user experience with dark/light mode support.

---

109-111: No changes needed. The emoji extension configuration in lines 110-111 is correct and matches Zensical's documented default configuration. The zensical namespace for these extensions is required to support icon inlining functionality beyond what standard pymdownx provides.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.53%. Comparing base (a158041) to head (59ad315).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2697   +/-   ##
=======================================
  Coverage   99.53%   99.53%           
=======================================
  Files          81       81           
  Lines       11404    11404           
  Branches     1362     1362           
=======================================
  Hits        11351    11351           
  Misses         32       32           
  Partials       21       21           

Flag	Coverage Δ
unittests	99.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

[codspeed-hq]

CodSpeed Performance Report

Merging #2697 will not alter performance

_{Comparing add-zensical-config (59ad315) with main (a158041)}

Summary

✅ 52 untouched
⏩ 10 skipped¹

Footnotes

1. 10 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩