fix: remove zensical.toml references to deleted stub pages#542
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the documentation navigation configuration by removing links in zensical.toml that point to deleted stub markdown pages so the docs build reflects only existing content. Flow diagram for docs build using updated zensical.toml navigationflowchart TD
ZT[zensical.toml
nav entries]
MD[Existing
markdown files]
DB[Docs build
process]
OUT[Generated docs
navigation]
ZT --> DB
MD --> DB
DB --> OUT
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/zensical.toml" line_range="10-11" />
<code_context>
{"Changelog" = "changelog.md"}
]},
{"Tutorial" = [
- {"Data Analysis" = "data_analysis.md"},
- {"Simulations" = "simulations.md"}
]}
]
site_dir = "_build/html"
</code_context>
<issue_to_address>
**suggestion:** Consider removing the empty "Tutorial" section or adding at least one entry to avoid an empty nav group.
With `"Data Analysis"` and `"Simulations"` removed, `"Tutorial"` is now an empty array. Depending on the docs theme, this may render as a blank or non-clickable sidebar section. To avoid a confusing nav entry, either drop the `"Tutorial"` group until content exists or add at least one child item.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| {"Tutorial" = [ | ||
| {"Data Analysis" = "data_analysis.md"}, | ||
| {"Simulations" = "simulations.md"} | ||
| ]} |
There was a problem hiding this comment.
suggestion: Consider removing the empty "Tutorial" section or adding at least one entry to avoid an empty nav group.
With "Data Analysis" and "Simulations" removed, "Tutorial" is now an empty array. Depending on the docs theme, this may render as a blank or non-clickable sidebar section. To avoid a confusing nav entry, either drop the "Tutorial" group until content exists or add at least one child item.
There was a problem hiding this comment.
Code Review
This pull request removes the 'Data Analysis' and 'Simulations' entries from the 'Tutorial' navigation group in the documentation configuration. Feedback suggests that the entire 'Tutorial' block should be removed to avoid displaying an empty section in the documentation user interface.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/zensical.toml (11-12)
The removal of these entries leaves the Tutorial navigation group empty. To maintain a clean documentation structure and avoid displaying an empty section in the UI, the entire Tutorial block should be removed from the nav array.
5d14d14 to
c8c85f9
Compare
Summary
zensical.tomlnav entries pointing to deleted stub.mdfilesFollows up on the stub page removal in
fix/empty-stub-pages.Test plan
Summary by Sourcery
Bug Fixes: