Skip to content

docs: auto-maintain administrator command and permission tables - #38

Draft
BenCodez wants to merge 4 commits into
mainfrom
docs/source-derived-command-reference-2026-11
Draft

BenCodez wants to merge 4 commits into
mainfrom
docs/source-derived-command-reference-2026-11

Conversation

@BenCodez

@BenCodez BenCodez commented Nov 10, 2026 •

Copy link
Copy Markdown
Owner

Goal

Generate an administrator-friendly Commands & Permissions reference automatically, without making changes to VotingPlugin's runtime.

User-facing documentation

  • A clean table of Command, Permission, and Description for /av and /vote.
  • No links to Java source files or per-command implementation locations.
  • No raw Java expressions advertised as runnable commands: dynamic/configuration-based registrations are excluded with an explicit limitation.
  • Clear distinction between the development snapshot and the published stable-release reference.

Implementation

  • A small Python generator inspects CommandHandler registration definitions offline, rather than exporting data during Minecraft startup.
  • Tests cover parsed command syntax, permission expansion, omitted dynamic expressions, and the absence of source-code links in rendered Markdown.
  • A scheduled/manual Wiki workflow checks upstream definitions and can propose an update PR when the command reference changes.

Scope and limitations

The first pass covers literal Bukkit handler registrations in CommandLoader and VoteStreaksCommand. Conditional commands and registrations supplied by other command registries or proxy dispatchers still need separate handling. Runtime availability depends on configuration, debug settings, and installed version. The published wiki should not treat this as a guaranteed stable command list.

Status: Draft pending maintainer approval of the administrator-facing output. No changes have been merged. AI assistance used to create the generator and documentation.

@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 65937737-3a4a-45fe-b9a7-e1aac77e6ca4
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-10T00:23:19.032359Z 0fc65fe Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@BenCodez
BenCodez marked this pull request as draft November 10, 2026 00:49
@BenCodez BenCodez changed the title docs: derive command reference from CommandHandler Java source (no runtime changes) docs: auto-maintain administrator command and permission tables Nov 10, 2026

This branch has not been deployed

No deployments
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