Soaps Wiki Standard

Shared rules for every SoapsUniverse plugin wiki. Follow this when adding or polishing docs.

Goals

• A wiki is the complete manual for that plugin: every feature, command, permission, config key, GUI flow, placeholder, and integration that the plugin actually ships.
• Document only what exists in source (plugin.yml, resource YAML, Java). Never invent options.
• Prefer tables, numbered steps, and defaults over marketing filler.

Core pages (exact filenames)

File	Role
README.md	Hub: one short pitch, version, requirements, optional deps, quick-link table
Introduction.md	What it is / who it is for / suite fit (no install steps)
Getting-Started.md	Install → first-run checklist → verify commands
Configuration.md	File map, reload commands, important concepts (not full YAML dumps)
Default-Config-Files.md	Full shipped defaults from src/main/resources
Commands-and-Permissions.md	Complete command + permission reference (Admin may split; keep a hub)
Integrations.md	Soft deps and bridges only
Examples.md	Short real recipes
FAQ.md	Real failure modes
Changelog.md	Version history
_Sidebar.md	Navigation
_Footer.md	Version line + Website + Discord

Feature / guide pages are extra under Guides. Do not rename the core set (Default-Configs.md, Bridges-and-Integrations.md, etc.).

Sidebar skeleton

### Soaps{Name} Wiki

**Getting Started**
- [Home](/wiki/soapscommon/)
- [Introduction](/wiki/soapscommon/introduction/)
- [Getting Started](/wiki/soapscommon/getting-started/)

**Configuration**
- [Configuration](/wiki/soapscommon/configuration/)
- [Default Config Files](/wiki/soapscommon/default-config-files/)

**Guides**   ← rename per plugin (Features, Portals, Quest Authoring, Systems, …)
- …

**Reference**
- [Commands and Permissions](/wiki/soapscommon/commands-and-permissions/)
- [Placeholders](/wiki/soapscommon/placeholders/)   ← omit if none
- [Integrations](/wiki/soapscommon/integrations/)

**Support**
- [Examples](/wiki/soapscommon/examples/)
- [FAQ](/wiki/soapscommon/faq/)
- [Changelog](/wiki/soapscommon/changelog/)

---
[SoapsUniverse.com](https://www.soapsuniverse.com) | [Discord](https://discord.gg/mawAzwFq)

Rules: always use .md in links; keep section titles consistent across plugins; only the Guides block title changes.

Page overlap rules

Page	Allowed	Forbidden
README	Pitch, version, requirements, quick links	Tutorials, full command lists, YAML dumps
Introduction	Concept and player/staff loop	Download / install steps
Getting Started	Install, checklist, verify	Full feature encyclopedia
Configuration	What each file is for, reload, key interactions	Pasting entire YAML
Default Config Files	Exact jar defaults	How-to tutorials
Feature guides	Setup, behavior, keys, gotchas	Repeating full install

Feature page template

# Feature name

## Overview
## Requirements
## Player how-to
## Staff how-to
## GUI walkthrough   ← if applicable
## Commands
## Configuration     ← key | default | effect
## Examples
## Edge cases
## See also

Default Config Files rules

Header every time:

# Default Config Files

Shipped defaults from Soaps{Name} **{version}**.
On first run, missing files are copied to `plugins/Soaps{Name}/`.
Edit the **server copies**. Reload does not reset existing files to these defaults.

Then one ## filename.yml (or path) per user-facing resource file, with a complete fenced YAML block copied from src/main/resources.

• Include every editable shipped YAML (config.yml, messages.yml, gui.yml, feature files, etc.).
• Omit plugin.yml (commands/permissions pages own that).
• Runtime-only paths get a short Data (runtime) table, not a fake default dump.
• SoapsCommon: no config.yml — document code defaults instead.

Completeness gate (audit before writing)

Check docs against source; do not document missing features:

• Commands / subcommands / aliases (plugin.yml + registered commands)
• Permission nodes and defaults
• Every YAML under src/main/resources (except plugin.yml in dumps)
• GUI menus and non-obvious controls
• Placeholders
• SoftDepend / bridge behavior
• Module toggles (if any)
• Premium vs free splits (if any)

Writing voice

• Short imperative sentences (“Run /sf reload”).
• Tables for commands, permissions, keys, requirements.
• No filler (“powerful”, “comprehensive”, “in this guide we will”, “coming soon”).
• Version in README and Default Config Files header; match Changelog latest and plugin.yml.

Footer

**Soaps{Name} {version}** | {one-line description}

- [Website](https://www.soapsuniverse.com)
- [Discord](https://discord.gg/mawAzwFq)

Definition of done

1. Sidebar matches this skeleton
2. Core filenames match
3. README / Introduction / Getting Started do not repeat each other
4. Default Config Files includes every shipped editable YAML body
5. Commands and permissions match plugin.yml / code
6. A new admin can configure advanced use without reading source
7. Nothing is documented that the plugin does not implement