sdk%fix(zen): follow up base-sdk#32, base-sdk#33

[kwvg]

Additional Information

• Follow-up to sdk%doc: promote docs/ for Zensical namespace, write startup guide, clean up style guide for web publication, make docs guide informative #32

• Follow-up to sdk%ci: use comment syntax for doc splicing, add uv lockfile, use for dependency tracking, make CodeQL runner multi-lingual, add symlink linter #33

• Zensical preprocessing syntax has been updated to support omitting text from the webpage (i.e. meant only for display on GitHub) using the reserved label omit that can be used repeatedly (unlike other labels which can define one segment).

How Has This Been Tested?

./contrib/git_filter.py --fast-fail develop zen_p3 -- bash -c "./maint/lint_all.py --exclude lint_codeql && pytest && ./docs/build_docs.py"

Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional tests (note: N/A)
• I have made corresponding changes to the documentation
• I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

[github-actions]

Note

This pull request has no conflicts! 🎊 🎉 🎊

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Team

Run ID: acabafec-f25e-4f25-b7a4-b4ebde7677f5

📥 Commits

Reviewing files that changed from the base of the PR and between 71e48db and 186bcf9.

📒 Files selected for processing (14)

• .github/workflows/build_nightly.yml
• .github/workflows/pages.yml
• .github/workflows/pkg_num.yml
• .github/workflows/pkg_p2p_core.yml
• .github/workflows/pkg_params.yml
• .github/workflows/pkg_pkc.yml
• .github/workflows/pkg_pow.yml
• .github/workflows/pkg_primitives.yml
• .github/workflows/pkg_script.yml
• .github/workflows/pkg_types.yml
• docs/dev/about_docs.md
• docs/dev/maintenance.md
• docs/preprocess.py
• maint/README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The change adds omit-segment handling to documentation preprocessing, updates related documentation, and adjusts GitHub Actions workflow token handling and path filters.

Changes

Documentation omission

Layer / File(s)	Summary
Omit segment validation docs/preprocess.py	The preprocessor recognizes omit markers, removes labelled content, tracks code fences, and rejects malformed segments.
Preprocessor integration docs/preprocess.py	Top-level and included content passes through omit stripping. Sections with unclosed fences now raise ValueError.
Validation and documentation docs/preprocess.py, docs/dev/about_docs.md, docs/dev/maintenance.md, maint/README.md	Tests cover omit handling and malformed input. Documentation describes omit markers, and maintenance-only content uses them.

Workflow updates

Layer / File(s)	Summary
Workflow trigger and token updates .github/workflows/build_nightly.yml, .github/workflows/pages.yml	The nightly workflow passes CODECOV_TOKEN through the Codecov action input. Pages pull request triggers include project and README files.
Shared package path filters .github/workflows/pkg_*.yml	Package workflows reuse YAML anchors for identical push and pull_request path filters.

Sequence Diagram(s)

sequenceDiagram
  participant DocumentationInput
  participant IncludePreprocessor
  participant _strip_omitted
  participant IncludedFile
  DocumentationInput->>IncludePreprocessor: provide source lines
  IncludePreprocessor->>_strip_omitted: strip top-level omit segments
  IncludePreprocessor->>IncludedFile: expand include directive
  IncludedFile-->>IncludePreprocessor: return included lines
  IncludePreprocessor->>_strip_omitted: strip omit segments from included lines
  _strip_omitted-->>IncludePreprocessor: return filtered lines or ValueError

Loading

Merge Risk: ⚪ Minimal · up to 186bc

Omit-marked documentation content is removed from generated pages while remaining available in source rendering, with validation for malformed segments and fenced content. The workflow updates preserve package trigger behavior and broaden Pages checks for relevant documentation inputs; no current merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 38.89% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 18 functions across 1 files. (13 skipped:…	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title identifies a Zensical fix and links it to the referenced follow-up work. It is related to the changes, although it does not state the specific omit-processing and workflow updates.
Description check	✅ Passed	The description clearly explains the new omit preprocessing feature, related documentation changes, and validation steps. It is directly related to the changeset.

Full details: Docstring Coverage

Explanation

Docstring coverage is 38.89% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 18 functions across 1 files. (13 skipped: 13 unsupported.)

• Fix all pre-merge checks with AI

---

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