Update renovate and prek documentation

[daniel-mizsak]

• Linting passes
• Tests are added and passing
• Documentation is updated

Summary by CodeRabbit

• Documentation

  • Updated tools documentation with new entries for Prek and Renovate.
  • Added documentation for Prek Git hook management.
  • Added documentation for Renovate dependency automation.

• Refactor

  • Transitioned from Pre-Commit to Prek for managing Git hooks.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request migrates the project from the pre-commit tool to prek for git hook management. This includes renaming the Justfile task, removing the pre-commit.ci badge from the README, deleting Pre-Commit documentation, and adding new documentation for Prek and Renovate. Configuration navigation files are updated accordingly.

Changes

Cohort / File(s)	Summary
Tool Migration Documentation docs/tools/pre-commit.md, docs/tools/prek.md	Removed Pre-Commit documentation (25 lines) and added new Prek documentation (27 lines) describing git hook management configuration and usage via uv run prek run --all-files or just prek.
New Documentation docs/tools/renovate.md	Added new documentation for Renovate dependency update automation, covering configuration location (.github/renovate.json5) and supported dependency sources.
Navigation & Index Updates docs/tools/index.md, zensical.toml	Updated tools index and site navigation configuration, replacing Pre-Commit entry with Prek and adding Renovate entry.
Configuration Changes Justfile	Renamed Justfile task from pre-commit to prek under the qa-extra group; command body (uv run prek run --all-files) unchanged.
README Cleanup README.md	Removed pre-commit.ci status badge link from top badge section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• PR #120: Makes identical code-level changes migrating from pre-commit to prek (Justfile and navigation updates) and adds Renovate configuration.

Poem

🐰 From pre-commit's hook we hop away,
To prek's fresh gates we skip and play,
Renovate joins the garden spree—
Dependencies dance, wild and free! 🌿✨

🚥 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 title accurately reflects the main changes: documentation updates for Renovate and Prek tools, plus the Justfile task rename.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/renovate-docs

---

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

[codecov]

Codecov Report

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

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #122   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines            7         7           
=========================================
  Hits             7         7           

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

[coderabbitai]

🧹 Nitpick comments (3)

docs/tools/prek.md (2)

5-5: Consider clarifying the migration note for existing users.

Since this PR migrates the template from pre-commit to prek, it might be worth explicitly mentioning that prek is a drop-in, Rust-based reimplementation that reuses the same .pre-commit-config.yaml, so existing hooks keep working. That framing helps readers understand why the config filename still references pre-commit.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/tools/prek.md` at line 5, The migration note about prek is unclear for
existing users; update the text in the prek documentation to state that prek is
a drop-in, Rust-based reimplementation that reuses the existing
.pre-commit-config.yaml so current pre-commit hooks continue to work, and
explicitly explain that this is why the config filename still references
pre-commit; mention the terms "prek" and ".pre-commit-config.yaml" in the
sentence so readers understand compatibility and the reason for the unchanged
filename.

---

7-7: Optional: minor wording polish.

LanguageTool flags two small style nits you may want to address for consistency with the rest of the docs.

✏️ Proposed wording tweaks

-The `prek` related settings are defined in the `.pre-commit-config.yaml` file.
+The `prek`-related settings are defined in the `.pre-commit-config.yaml` file.

-I used to use [pre-commit](https://pre-commit.com){target} before, but switched to `prek` as it seems to be more actively maintained.
+I used to use [pre-commit](https://pre-commit.com){target} before, but switched to `prek` as it seems more actively maintained.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/tools/prek.md` at line 7, The sentence "The `prek` related settings are
defined in the `.pre-commit-config.yaml` file." needs minor wording polish:
change "`prek` related" to a hyphenated form ("`prek`-related") and simplify the
file reference by removing the extra "file" word or trailing period for
consistency with other docs; update the sentence containing "The `prek` related
settings" and the `.pre-commit-config.yaml` reference accordingly.

docs/tools/renovate.md (1)

7-7: Optional: minor wording/casing nits.

✏️ Proposed tweaks

-The `renovate` related settings are defined in the `.github/renovate.json5` file.
+The `renovate`-related settings are defined in the `.github/renovate.json5` file.

The LanguageTool “GitHub” casing hint is a false positive here — .github/ is the correct directory name.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/tools/renovate.md` at line 7, The sentence referencing the renovate
settings should keep the literal `.github/renovate.json5` directory name and
avoid changing its casing; update the wording if desired but do not alter
`.github/renovate.json5` (the string `.github/renovate.json5` and the term
`renovate` identify the target text). If you rephrase, make it a concise
sentence like "The renovate settings are defined in `.github/renovate.json5`."
and ensure the directory name remains exactly `.github/` to avoid the
LanguageTool false positive.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/tools/prek.md`:
- Line 5: The migration note about prek is unclear for existing users; update
the text in the prek documentation to state that prek is a drop-in, Rust-based
reimplementation that reuses the existing .pre-commit-config.yaml so current
pre-commit hooks continue to work, and explicitly explain that this is why the
config filename still references pre-commit; mention the terms "prek" and
".pre-commit-config.yaml" in the sentence so readers understand compatibility
and the reason for the unchanged filename.
- Line 7: The sentence "The `prek` related settings are defined in the
`.pre-commit-config.yaml` file." needs minor wording polish: change "`prek`
related" to a hyphenated form ("`prek`-related") and simplify the file reference
by removing the extra "file" word or trailing period for consistency with other
docs; update the sentence containing "The `prek` related settings" and the
`.pre-commit-config.yaml` reference accordingly.

In `@docs/tools/renovate.md`:
- Line 7: The sentence referencing the renovate settings should keep the literal
`.github/renovate.json5` directory name and avoid changing its casing; update
the wording if desired but do not alter `.github/renovate.json5` (the string
`.github/renovate.json5` and the term `renovate` identify the target text). If
you rephrase, make it a concise sentence like "The renovate settings are defined
in `.github/renovate.json5`." and ensure the directory name remains exactly
`.github/` to avoid the LanguageTool false positive.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d5395df3-4343-4039-a4d7-522795f7e4d3

📥 Commits

Reviewing files that changed from the base of the PR and between e3f45ae and aa2cdda.

📒 Files selected for processing (7)

• Justfile
• README.md
• docs/tools/index.md
• docs/tools/pre-commit.md
• docs/tools/prek.md
• docs/tools/renovate.md
• zensical.toml

💤 Files with no reviewable changes (2)

• docs/tools/pre-commit.md
• README.md

[Copilot]

Pull request overview

Updates the documentation/navigation to reflect using Prek for git hooks and adds a new docs page for Renovate dependency updates.

Changes:

• Replace the “Pre-Commit” docs entry with “Prek” and add “Renovate” in the Zensical navigation and tools index.
• Add new documentation pages for prek and renovate, and remove the old pre-commit docs page.
• Update the Justfile recipe name from pre-commit to prek, and remove the pre-commit.ci badge from the README.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
zensical.toml	Updates docs navigation to point to tools/prek.md and tools/renovate.md.
docs/tools/renovate.md	Adds Renovate documentation and references .github/renovate.json5.
docs/tools/prek.md	Adds Prek documentation and usage examples (including just prek).
docs/tools/pre-commit.md	Removes obsolete Pre-Commit documentation page.
docs/tools/index.md	Updates the tools list to include Prek and Renovate.
README.md	Removes the pre-commit.ci status badge.
Justfile	Renames the recipe to prek to match the new hook runner.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

✅MegaLinter analysis: Success

Descriptor	Linter	Files	Fixed	Errors	Warnings	Elapsed time
✅ ACTION	actionlint	3		0	0	0.06s
✅ COPYPASTE	jscpd	yes		no	no	1.35s
✅ MARKDOWN	markdownlint	18		0	0	1.16s
✅ MARKDOWN	markdown-table-formatter	19		0	0	0.24s
✅ REPOSITORY	checkov	yes		no	no	20.08s
✅ REPOSITORY	gitleaks	yes		no	no	0.16s
✅ REPOSITORY	git_diff	yes		no	no	0.01s
✅ REPOSITORY	grype	yes		no	no	40.29s
✅ REPOSITORY	kics	yes		no	no	2.28s
✅ REPOSITORY	secretlint	yes		no	no	1.02s
✅ REPOSITORY	syft	yes		no	no	1.97s
✅ REPOSITORY	trivy	yes		no	no	11.63s
✅ REPOSITORY	trivy-sbom	yes		no	no	0.4s
✅ REPOSITORY	trufflehog	yes		no	no	4.87s
✅ YAML	prettier	9		0	0	0.51s
✅ YAML	v8r	9		0	0	8.29s
✅ YAML	yamllint	9		0	0	0.4s

See detailed reports in MegaLinter artifacts

Show us your support by starring ⭐ the repository