Skip to content

Initial setup of move to Zensical - #236

Merged
jxmx merged 6 commits into
mainfrom
zensical
Jul 11, 2026
Merged

Initial setup of move to Zensical#236
jxmx merged 6 commits into
mainfrom
zensical

Conversation

@jxmx

@jxmx jxmx commented Jul 7, 2026

Copy link
Copy Markdown
Member

This begins to address #230

Summary by CodeRabbit

  • Documentation

    • Updated setup, local editing, preview, and publishing instructions to use Zensical instead of MkDocs.
    • Revised platform-specific onboarding steps and environment setup guidance.
    • Adjusted getting-started sections and command examples to match the new workflow.
  • Chores

    • Updated project requirements to depend on Zensical.

@jxmx
jxmx requested review from Allan-N, Mason10198, mkmer and ve7fet July 7, 2026 16:05
@jxmx jxmx self-assigned this Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 42578e2d-df7a-46a7-8bf1-07e9aa040088

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch zensical

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

Comment @coderabbitai help to get the list of available commands.

@mkmer

mkmer commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

7 issues found when using zensical (not related to the updates here).
Looks like the instructions work fine

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 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 `@README.md`:
- Around line 224-226: The WSL2 activation command in the README is incorrect
and should be replaced with the actual virtual environment activation command
used in the setup instructions. Update the shell snippet that currently
references the typoed activation script so it matches the earlier environment
setup, and verify the surrounding setup guidance in README stays consistent with
the virtualenv path and activation flow.

In `@requirements.txt`:
- Line 1: The bootstrap requirements change drops MkDocs packages that
activate-mkdocs-venv still installs via requirements.txt, so keep mkdocs and
mkdocs-print-site-plugin in the bootstrap dependency list. Update the
requirements entry or the bootstrap install path so the mkdocs build environment
created under ~/.mkdocs still has those dependencies available, and reference
activate-mkdocs-venv and the requirements.txt dependency set when making the
fix.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 48c15bff-cec8-439f-884e-0d9670713db4

📥 Commits

Reviewing files that changed from the base of the PR and between 9776613 and a995234.

📒 Files selected for processing (2)
  • README.md
  • requirements.txt

Comment thread README.md
Comment thread requirements.txt Outdated

@Allan-N Allan-N left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the Makefile needs a few changes

@jxmx

jxmx commented Jul 11, 2026

Copy link
Copy Markdown
Member Author

7 issues found when using zensical (not related to the updates here). Looks like the instructions work fine

This looks like a syntax difference between mkdocs and zensical. I fixed them.

@jxmx
jxmx merged commit 641e22c into main Jul 11, 2026
2 checks passed
@jxmx
jxmx deleted the zensical branch July 11, 2026 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants