Skip to content

docs: document Command System V2 and Atelier REPL#90

Merged
CedaryCat merged 1 commit into
mainfrom
develop
May 11, 2026
Merged

docs: document Command System V2 and Atelier REPL#90
CedaryCat merged 1 commit into
mainfrom
develop

Conversation

@CedaryCat

@CedaryCat CedaryCat commented May 11, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Document Command System V2 and the Atelier REPL across the developer docs and README, and bump the project version for the next release.

Build:

  • Update GitVersion configuration to bump the next-version from v0.2.1 to v0.3.1.

Documentation:

  • Add detailed plugin developer documentation for Command System V2, including controller declarations, parameter binding, flags, guards, TShock-specific bindings, and installation/uninstallation, in both English and Chinese guides.
  • Introduce a new section describing Atelier REPL usage, session model, meta-commands, and best practices in the plugin dev guide in both English and Chinese.
  • Explain Command System V2 and Atelier REPL as core subsystems in the developer overview docs, with deep-dive implementation details and architectural best practices, in both English and Chinese.
  • Highlight Command System V2 and Atelier REPL as headline features in the main README and docs README, and reference where to find more detailed guides.

@sourcery-ai

sourcery-ai Bot commented May 11, 2026

Copy link
Copy Markdown

Reviewer's Guide

Documents the new Command System V2 and Atelier REPL across English and Chinese developer docs, surfaces them in the top-level READMEs, and bumps the GitVersion next-version to v0.3.1.

File-Level Changes

Change Details Files
Add detailed Command System V2 documentation to the plugin development guides (EN/ZH).
  • Extend dev-plugin table of contents with a new Command System V2 section and subsections.
  • Document controller declaration, parameter binding, flags, guards/permissions, TShock-specific bindings, and installation/uninstallation patterns with code examples.
  • Clarify architectural relationship between the neutral UTSL command engine and the TShock integration layer, including best-practice guidance for plugin authors.
docs/dev-plugin.md
docs/dev-plugin.zh-cn.md
Describe Command System V2 and Atelier REPL as core subsystems in the developer overview docs (EN/ZH).
  • Add CommandSystem and Atelier REPL entries to the core services list, including their roles in the architecture.
  • Introduce new subsections that deep-dive Command System V2 and Atelier REPL internals with layered architecture, data flow, and best practices.
  • Link these new sections from the overview TOCs for easier navigation.
docs/dev-overview.md
docs/dev-overview.zh-cn.md
Expose Command System V2 and Atelier REPL in the top-level README feature lists and plugin guidance (EN/ZH).
  • Extend feature tables to highlight Command System V2 and Atelier REPL capabilities and positioning.
  • Add a short recommendation that plugins should use Command System V2 for commands, noting discovery, binding, permissions, and help/audit integration.
  • Mention Atelier REPL as the preferred way to inspect/script against a running world without writing a full plugin, with pointers to the detailed docs.
README.md
docs/README.zh-cn.md
Bump GitVersion configuration to the next documented version.
  • Update the configured next-version from v0.2.1 to v0.3.1 to reflect the new feature set.
GitVersion.yml

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

@CedaryCat CedaryCat merged commit d72faa9 into main May 11, 2026
13 checks passed

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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


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.

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