Docs/GitHub pages#64
Merged
Merged
Conversation
- Add Just the Docs remote theme with ezrtp color scheme (dark bg, blue accent) - Add GitHub Actions workflow to build and deploy docs on release - Add Markdown lint config matching EzEconomy conventions - Add Gemfile for local Jekyll preview
- Add home page (docs/index.md) with navigation tables for server owners and developers - Add section index pages for Config Reference, Integrations, and Platform Modules - Add Just the Docs front matter (title, nav_order, parent, has_children) to all existing pages so they appear correctly in the sidebar navigation
- commands.md (nav_order 3) — player commands, admin subcommands, forcertp, WorldGuard region mode, cheatsheet - permissions.md (nav_order 4) — permissions table with default and description columns - Update home page navigation table to link both pages - Bump nav_order on all downstream pages (Messages → 5, Operations → 6, ...)
Documents all five search-pattern values (random, circle, square, diamond, triangle) with per-pattern descriptions, geometry notes, use-case guidance, and a comparison summary table. Links from home page and rtp.yml.
Replace brief bullet-point stubs with server-owner-targeted documentation: - config.yml: full settings table, annotated example, callout note - rtp.yml: sectioned (bounds, safety, countdown, biomes, protection, on-join, named centers, debug) with tables, annotated YAML examples, and plain-English explanations - limits.yml: per-world/per-group override pattern, storage backend section - gui.yml: slot numbering diagram, full entry field table, biome and current-world examples - queue.yml: explains the queue, tick reference, busy-server example - network.yml: lobby concept explained, all entry fields in a table, proxy setup note - force-rtp.yml: full settings table, clarifies per-bypass rationale
- Maven and Gradle dependency snippets with correct artifact coordinates - plugin.yml depend/softdepend examples - Full method reference: isAvailable(), rtpPlayer() overloads, getTeleportService() - TeleportReason enum table (COMMAND vs JOIN) - TeleportService interface shown in full - RandomTeleportSettings YAML key reference table with types and examples - Null-safety guidance for soft dependencies - Worked example combining custom settings, biome filter, and success callback
- Move docs/topics/ -> topics/ (plugin listing files don't belong in the Jekyll docs site and triggered spurious markdownlint failures) - Fix MD032: add blank lines around lists in plugin-api.md, placeholderapi.md, and protection-worldguard-griefprevention.md - Fix MD040: add 'text' language tag to fenced code block in gui.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added Github Pages documentation for EzRTP