Skip to content

Update stale source path references in documentation (#345)#376

Draft
leynos wants to merge 1 commit into
mainfrom
issue-345-fix-stale-doc-paths
Draft

Update stale source path references in documentation (#345)#376
leynos wants to merge 1 commit into
mainfrom
issue-345-fix-stale-doc-paths

Conversation

@leynos

@leynos leynos commented Jun 12, 2026

Copy link
Copy Markdown
Owner

Summary

Closes #345

Corrects every stale source path the issue lists:

  • docs/netsuke-design.md:895src/manifest.rssrc/manifest/mod.rs
  • docs/netsuke-design.md:2436src/runner.rssrc/runner/mod.rs
  • docs/netsuke-design.md:2438src/runner/process.rssrc/runner/process/mod.rs
  • docs/developers-guide.md:45src/graph_view/render_html.rssrc/graph_view/render_html/mod.rs
  • docs/rust-testing-with-rstest-fixtures.md:1130 — removed the obsolete src/fixtures.rs example ("a dedicated fixtures module" instead)

docs/contents.md needs no change (no documentation structure changed).

Validation

  • make markdownlint — 0 errors
  • make check-fmt — pass

🤖 Generated with Claude Code

Summary by Sourcery

Update documentation to reflect current Rust module file structure and fixture organization guidance.

Documentation:

  • Correct source file path references in design and developer documentation to point to the current module-based layout.
  • Revise testing guide wording to describe using a dedicated fixtures module instead of a specific src/fixtures.rs file.

Several documents pointed at module paths that no longer exist after
the manifest, runner, and graph-view refactors:

- `docs/netsuke-design.md`: `src/manifest.rs` → `src/manifest/mod.rs`,
  `src/runner.rs` → `src/runner/mod.rs`, and `src/runner/process.rs`
  → `src/runner/process/mod.rs`;
- `docs/developers-guide.md`: `src/graph_view/render_html.rs` →
  `src/graph_view/render_html/mod.rs`;
- `docs/rust-testing-with-rstest-fixtures.md`: drop the reference to
  the removed `src/fixtures.rs`, pointing at "a dedicated fixtures
  module" instead.

`docs/contents.md` is unaffected — no document structure changed.
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

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: ASSERTIVE

Plan: Pro Plus

Run ID: 7668d056-333b-459d-92df-c54c225db410

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 issue-345-fix-stale-doc-paths

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

@sourcery-ai

sourcery-ai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates documentation to point to the current Rust module layout and removes a stale fixture-module example so docs no not reference non-existent source paths.

File-Level Changes

Change Details Files
Align netsuke design documentation with new manifest and runner module paths.
  • Updated reference from src/manifest.rs to src/manifest/mod.rs in the manifest convenience functions section.
  • Updated reference from src/runner.rs to src/runner/mod.rs for CLI execution and dispatch.
  • Updated reference from src/runner/process.rs to src/runner/process/mod.rs in the process management and helpers description, reflowing the line accordingly.
docs/netsuke-design.md
Modernize guidance on where to place shared fixtures in Rust tests.
  • Replaced the concrete src/fixtures.rs path example with a generic "dedicated fixtures module" phrasing under #[cfg(test)] to avoid referencing a non-existent file, while keeping the guidance about shared fixtures in the library crate.
docs/rust-testing-with-rstest-fixtures.md
Update developers guide to reference the correct HTML renderer module path.
  • Changed the HtmlRenderer documentation link from ../src/graph_view/render_html.rs to ../src/graph_view/render_html/mod.rs so it matches the current module layout.
docs/developers-guide.md

Assessment against linked issues

Issue Objective Addressed Explanation
#345 Update or remove all listed stale source path references in the documentation files to match current module paths.
#345 Keep docs/contents.md accurate given the documentation changes.
#345 Ensure formatting and markdown checks pass after the documentation updates.

Possibly linked issues


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

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.

Update stale source path references in documentation

1 participant