Skip to content

fix: remove zensical.toml references to deleted stub pages#542

Open
joamatab wants to merge 1 commit into
mainfrom
fix/cleanup-deleted-refs
Open

fix: remove zensical.toml references to deleted stub pages#542
joamatab wants to merge 1 commit into
mainfrom
fix/cleanup-deleted-refs

Conversation

@joamatab
Copy link
Copy Markdown
Contributor

@joamatab joamatab commented May 22, 2026

Summary

  • Remove zensical.toml nav entries pointing to deleted stub .md files

Follows up on the stub page removal in fix/empty-stub-pages.

Test plan

  • Verify docs build succeeds

Summary by Sourcery

Bug Fixes:

  • Remove navigation links to non-existent tutorial stub pages from the documentation sidebar.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 22, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates 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 navigation

flowchart TD
  ZT[zensical.toml
  nav entries]
  MD[Existing
  markdown files]
  DB[Docs build
  process]
  OUT[Generated docs
  navigation]

  ZT --> DB
  MD --> DB
  DB --> OUT
Loading

File-Level Changes

Change Details Files
Clean up docs navigation by removing entries for deleted stub pages.
  • Removed the 'Data Analysis' tutorial nav entry that referenced a removed markdown file.
  • Removed the 'Simulations' tutorial nav entry that referenced a removed markdown file.
docs/zensical.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/zensical.toml
Comment on lines 10 to 11
{"Tutorial" = [
{"Data Analysis" = "data_analysis.md"},
{"Simulations" = "simulations.md"}
]}
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.

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.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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)

medium

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.

@joamatab joamatab force-pushed the fix/cleanup-deleted-refs branch from 5d14d14 to c8c85f9 Compare May 22, 2026 20:42
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.

1 participant