docs: migrate documentation to Zensical#339
Merged
Merged
Conversation
…ence docs - Added authoring references for various subjects including markdown patterns, callouts, tables, and layouts. - Introduced dependency references to map features with configuration needs and extension prerequisites. - Included a scaffold for content types and guidance for customization boundaries. - Updated docs reference outline for later structured extractions.
- Renamed and enhanced local docs tasks (`run-docs` → `docs:serve` and new `docs:build`). - Migrated tasks to use `zensical` for serving and building docs. - Removed deprecated dependency references to clean up `uv.lock`. - Added `deepmerge` as a new dependency in `uv.lock`.
- Cleaned up outdated SonarCloud badge link from README for better clarity. - Retained other essential badges for build and license status.
- Deleted the unused `changelog.md` file to reduce redundancy in documentation. - Reorganized and re-indented content in `index.md` for enhanced readability and clarity. - Fixed various formatting inconsistencies in tables and lists for a cohesive style. - Updated callout and button links for better navigation within the docs.
- Deleted the `Changelog` entry from `mkdocs.yml` navigation to align with recent cleanup. - Ensured navigation remains consistent by maintaining proper structure after removal.
- Removed `pngquant` installation as it's unused in the current workflow. - Replaced `mkdocs build` with `zensical build` to align with updated tooling. - Commented out the Python setup step to simplify and streamline the workflow.
Signed-off-by: Jonas Ha <61319894+j-d-ha@users.noreply.github.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #339 +/- ##
=======================================
Coverage 87.38% 87.38%
=======================================
Files 113 113
Lines 2814 2814
Branches 351 351
=======================================
Hits 2459 2459
Misses 254 254
Partials 101 101 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
- Cleaned up unused and commented `pngquant` installation in `docs.yaml` workflow file. - Retained `uv` installation for workflow continuity.
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.
🚀 Pull Request
📋 Summary
Migrates the project documentation site to use the Zensical authoring system. Adds a comprehensive set of authoring and configuration reference docs under
.agents/skills/zensical-site/references/, updates the docs workflow, cleans up outdated content (changelog nav entry, SonarCloud badge), and optimizes MkDocs dependencies.🔄 Changes
zensical-siteskill with full reference docs (authoring, content types, voice/tone, configuration, front matter, markdown/links, callouts, layout, etc.)docs.yamlworkflow for Zensical-compatible buildpyproject.tomldependencies and rebuilduv.lockLocalDevTasks.yml✅ Checklist
🧪 Related Issues or PRs
Closes #208
💬 Notes for Reviewers
Reference docs under
.agents/skills/zensical-site/references/are authoring guides for Claude — not end-user docs. The workflow change indocs.yamlaligns with the Zensical build pipeline.