Annotate shell snippets in srgn guide

[leynos]

Summary

• mark shell examples in srgn guide with sh language fences
• trim trailing whitespace in roadmap

Testing

• make fmt
• make markdownlint
• make nixie (fails: libatk-1.0.so.0: cannot open shared object file)
• make lint
• make test

---

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

Summary by Sourcery

Annotate shell code blocks in the srgn guide with sh fences instead of bash and trim trailing whitespace in the roadmap documentation

Documentation:

• Change all shell code fences in docs/srgn.md from bash to sh to improve syntax highlighting
• Remove trailing whitespace in docs/roadmap.md

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Improved formatting in the roadmap document by removing unnecessary trailing whitespace and blank lines.
  • Updated all shell command examples in the documentation to use the sh code block identifier for consistency.

Walkthrough

Update documentation by correcting code block language identifiers from bash to sh in shell command examples and remove trailing whitespace from a checklist item in the roadmap. No changes are made to code, logic, or public interfaces; all modifications are strictly editorial.

Changes

Cohort / File(s)	Change Summary
Roadmap Formatting Cleanup docs/roadmap.md	Remove trailing whitespace after a checklist item; adjust blank lines and ensure consistent formatting.
Shell Code Block Language Tag Update docs/srgn.md	Change all shell command code block language identifiers from bash to sh throughout the documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Format markdown documentation #22: Updates markdown formatting and code block language tags in documentation, closely matching the adjustments made to language tags and formatting in this PR.

Suggested reviewers

• codescene-delta-analysis

Poem

Documentation shines, neat and bright,
Whitespace banished, code blocks right.
From bash to sh, the tags align,
Markdown’s order, simply divine.
A gentle sweep, a tidy page—
Let clarity be all the rage!
✨📜

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f41fd2f and a94a80c.

📒 Files selected for processing (2)

• docs/roadmap.md (1 hunks)
• docs/srgn.md (13 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

docs/**/*.md

📄 CodeRabbit Inference Engine (AGENTS.md)

docs/**/*.md: Use the markdown files within the docs/ directory as a knowledge base and source of truth for project requirements, dependency choices, and architectural decisions.
Proactively update the relevant file(s) in the docs/ directory to reflect the latest state when new decisions are made, requirements change, libraries are added/removed, or architectural patterns evolve.

Files:

• docs/roadmap.md
• docs/srgn.md

**/*.md

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.md: Documentation must use en-GB-oxendict spelling and grammar, except for the naming of the "LICENSE" file.
Validate Markdown files using make markdownlint.
Run make fmt after any documentation changes to format all Markdown files and fix table markup.
Validate Mermaid diagrams in Markdown files by running make nixie.
Markdown paragraphs and bullet points must be wrapped at 80 columns.
Code blocks in Markdown must be wrapped at 120 columns.
Tables and headings in Markdown must not be wrapped.
Use dashes (-) for list bullets in Markdown.
Use GitHub-flavoured Markdown footnotes ([^1]) for references and footnotes.

Files:

• docs/roadmap.md
• docs/srgn.md

---

⚙️ CodeRabbit Configuration File

**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")

• Use en-GB-oxendict (-ize / -our) spelling and grammar
• Headings must not be wrapped.
• Documents must start with a level 1 heading
• Headings must correctly increase or decrease by no more than one level at a time
• Use GitHub-flavoured Markdown style for footnotes and endnotes.
• Numbered footnotes must be numbered by order of appearance in the document.

Files:

• docs/roadmap.md
• docs/srgn.md

⏰ Context from checks skipped due to timeout of 120000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build-test

🔇 Additional comments (2)

docs/roadmap.md (1)

91-93: Trimmed trailing whitespace — OK

Keep this as-is. The tidy-up is correct and risk-free.

docs/srgn.md (1)

143-149: Remove unnecessary line-length suggestions
All lines in sh code fences measure at most 84 characters—well under the 120-column limit. No breaks or continuations required.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/fix-fenced-code-blocks-in-srgn-documentation

---

🪧 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.
• 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.

Support

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

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

[greptile-apps]

Greptile Summary

This PR makes purely cosmetic documentation improvements to the netsuke codebase. The primary change standardizes shell code block annotations in the srgn guide documentation (docs/srgn.md) by converting all 13 code blocks from bash to sh language fences. This change is technically more accurate since the shell examples shown are POSIX-compliant commands that don't require bash-specific features, making the generic sh annotation more appropriate. Additionally, the PR includes a minor formatting fix in docs/roadmap.md that removes trailing whitespace from two lines in the 'Dynamic Features and Custom Functions' section.

These changes align with the project's documentation standards and linting requirements, as evidenced by the developer's testing with make markdownlint and make fmt commands. The modifications improve the technical accuracy of the documentation while ensuring consistent formatting across markdown files. This type of cleanup is common in well-maintained codebases where automated linting tools enforce formatting standards.

Important Files Changed

File Changes

Filename	Score	Overview
docs/srgn.md	5/5	Standardized shell code block language annotations from 'bash' to 'sh' across 13 code blocks
docs/roadmap.md	5/5	Removed trailing whitespace from two lines in the Dynamic Features section

Confidence score: 5/5

• This PR is safe to merge with minimal risk as it only contains documentation formatting improvements
• Score reflects that these are purely cosmetic changes with no functional code modifications that could introduce bugs
• No files require special attention as both changes are minor documentation improvements

_{2 files reviewed, no comments}

_{Edit Code Review Bot Settings | Greptile}

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR standardizes shell snippet annotations in the srgn guide by replacing all bash fences with sh, and trims trailing whitespace in the roadmap document.

File-Level Changes

Change	Details	Files
Standardize shell snippet annotations to 'sh'	Replaced all bash fences with sh for shell examples	docs/srgn.md
Clean up trailing whitespace in roadmap document	Removed extra spaces at end of lines and unnecessary blank lines	docs/roadmap.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.

[sourcery-ai]

Hey @leynos - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}