Paradaux
IssuesPAR-163Done
0

Docs accuracy pass: reference commands/permission nodes + key-feature guides + admin config guides

Goal

Audit and update /docs against the actual plugin source so it's current and complete:

  1. Reference (docs/reference/{treasury,business,chestshop,realty}.md) — every command and permission node accurate vs plugin.yml / @Route / hasPermission checks.
  2. Guides — ensure all key player features have a guide.
  3. Admin guides — admin-facing config docs (tax configuration, etc.) accurate vs the config classes/files.

Approach

Per-plugin audit (treasury + treasury-api-plugin, business-rian, ChestShop-3, realty) comparing doc ⇄ source: authoritative command list (usage + permission), permission-node list (default + description), key config keys; report missing/outdated/obsolete entries; then fix the docs in the existing user-docs house style.

Follow-up to PAR-162.

Comments

tesks · Jun 14, 2026, 5:13 PM

Beyond docs — a live config bug surfaced by the audit

The tax.balance.brackets bracket-key issue isn't only a docs gap. The shipped config.yml in both treasury/ and business-rian/ uses decimal threshold keys (100000.00: …). Bukkit/SnakeYAML treats the . as a path separator, so those keys are parsed as nested sections (10000000) instead of scalar keys — the loader (getKeys(false)new BigDecimal(key) / getString(key)) then reads the rates as 0. The map isn't empty (the integer parts parse), so it does not fall back to the correct hard-coded DEFAULT_BRACKETS.

Net: balance tax brackets may not be applying as intended in prod (rates effectively zeroed), on both personal (Treasury) and firm (Business) balance tax — matching the earlier "why isn't the balance tax config working on SC?" report. The unit tests only feed integer keys, so the mangling is untested.

Recommended plugin-side fix (separate from the docs): change the shipped config.yml bracket keys to integers in treasury/ and business-rian/, and update any live server config.yml. Docs now WARN operators to use integer keys (PR #20).

Activity

  • ParadauxIO linked a commit — Commit 8898cfe — Merge pull request #20 from MCCitiesNetwork/developJun 14, 2026, 5:20 PM
  • ParadauxIO linked a commit — Commit 559d960 — Docs accuracy pass: reference commands/perms, config + tax (PAR-163)Jun 14, 2026, 5:20 PM
  • ParadauxIO changed status to Status → DoneJun 14, 2026, 5:20 PM
  • ParadauxIO linked a pull request — PR #20 merged — Release: docs accuracy pass — reference commands/permissions + config/tax (PAR-163)Jun 14, 2026, 5:20 PM
  • tesks commentedJun 14, 2026, 5:13 PM
  • tesks changed status to Status → Pending ReleaseJun 14, 2026, 5:13 PM
  • ParadauxIO linked a pull request — PR #20 open — Release: docs accuracy pass — reference commands/permissions + config/tax (PAR-163)Jun 14, 2026, 5:13 PM
  • ParadauxIO linked a commit — Commit 559d960 — Docs accuracy pass: reference commands/perms, config + tax (PAR-163)Jun 14, 2026, 5:13 PM
  • tesks created the issueJun 14, 2026, 5:01 PM