Add examples section by leynos · Pull Request #14 · leynos/netsuke

leynos · 2025-07-14T00:24:13Z

Summary

document example Netsuke manifests in the design doc

Testing

make fmt
make lint
make test
make markdownlint
make nixie

https://chatgpt.com/codex/tasks/task_e_68744266c8e48322913a79e49aa54019

Summary by Sourcery

Add an “Example Manifests” section to the Netsuke design doc showcasing sample YAML manifests and refine the formatting of the command/script requirement description

Enhancements:

Merge the interpreter, command, and script requirement lines into a single succinct paragraph

Documentation:

Introduce Section 10 “Example Manifests” in netsuke-design.md with descriptions of sample YAML manifests in the examples directory

sourcery-ai · 2025-07-14T00:24:17Z

Reviewer's Guide

This PR enriches the design documentation by cleaning up paragraph formatting around command/script interpreter rules and appending a new “Example Manifests” section showcasing real-world Netsuke YAML schemas.

Flow diagram for the new Example Manifests documentation section

flowchart TD
    A[Start: Netsuke Design Doc]
    B[Section 10: Example Manifests]
    C[basic_c.yml: Minimal C project]
    D[photo_edit.yml: RAW photo conversion & gallery]
    E[visual_design.yml: SVG to PNG rasterisation]
    F[website.yml: Static site build]
    G[writing.yml: Multi-chapter PDF book]
    A --> B
    B --> C
    B --> D
    B --> E
    B --> F
    B --> G

File-Level Changes

Change	Details	Files
Refine formatting of interpreter and script rule description	Merged related lines into a single paragraph Removed extraneous line breaks and trailing spaces Reflowed the sentence on `command` vs `script` enforcement	`docs/netsuke-design.md`
Introduce Section 10: Example Manifests with sample YAML files	Added new heading for examples section Listed five sample manifests with descriptions and relative links Outlined purpose and directory location of example files	`docs/netsuke-design.md`

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

coderabbitai · 2025-07-14T00:24:19Z

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 42 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between f375b93 and 43c3a17.

📒 Files selected for processing (1)

docs/netsuke-design.md (2 hunks)

Summary by CodeRabbit

Documentation
- Improved formatting and cleaned up whitespace in the documentation.
- Added a new section showcasing example manifest files, with descriptions illustrating real-world use cases of the YAML schema.

Walkthrough

Update the documentation to enhance formatting, clarify the section on script interpreters and rule fields, and introduce a new section detailing example manifest files. Add descriptions for several real-world example manifests, illustrating various use cases for the YAML schema.

Changes

File(s)	Change Summary
docs/netsuke-design.md	Improved formatting, cleaned whitespace, clarified script interpreter paragraph, added Section 10 with descriptions of example manifests from the `examples/` directory.

Sequence Diagram(s)

No sequence diagram is generated as the changes are documentation-only.

Possibly related PRs

Add example manifests #8: Adds the example manifest files that are now referenced and described in the new documentation section, establishing a direct code-level link.

Poem

In docs, a new section appears with pride,
Example manifests now neatly described.
From C to photos, SVG and books—
Each YAML shines, so take a look!
With whitespace trimmed and clarity found,
Netsuke’s design is solid and sound.
📚✨

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch codex/add-links-to-example-manifests-in-docs

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sourcery-ai

Hey @leynos - I've reviewed your changes - here's some feedback:

The code span for the examples/ directory is split across two lines, which breaks the backticks—consolidate that into a single examples/ code span.
If the design doc has a table of contents, remember to add an entry for the new Examples section so readers can navigate to it easily.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- The code span for the examples/ directory is split across two lines, which breaks the backticks—consolidate that into a single `examples/` code span.
- If the design doc has a table of contents, remember to add an entry for the new Examples section so readers can navigate to it easily.

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

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c537e8 and f375b93.

📒 Files selected for processing (1)

docs/netsuke-design.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

docs/**/*.md

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

AGENTS.md

**/*.md

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

AGENTS.md

⚙️ CodeRabbit Configuration File

🪛 LanguageTool

docs/netsuke-design.md

[uncategorized] ~1395-~1395: Loose punctuation mark.
Context: ...basic_c.yml: a minimal C project compiling two obj...