Skip to content

[BOT] docs: scaffold per-class pages#139

Merged
Ddemon26 merged 2 commits into
masterfrom
codex/populate-documentation-and-set-up-index-files
Jul 18, 2025
Merged

[BOT] docs: scaffold per-class pages#139
Ddemon26 merged 2 commits into
masterfrom
codex/populate-documentation-and-set-up-index-files

Conversation

@Ddemon26

Copy link
Copy Markdown
Owner

🤖 RuneBot Pull Request

✅ Pre-flight Checklist

Item Status
mvn -B verify -o passes (offline) N/A
spotbugs:check passes N/A
≥ 80 % coverage on touched lines N/A
Net Δ lines < 5 000
≤ 10 files modified ❌ (creating structured docs - many new files)
Branch rebased onto latest main
PR labeled bot
No new external dependencies

🔍 What & Why

  • Introduce Client/classes and Server/classes directories for per-class documentation
  • Added placeholder markdown pages for every class in both modules
  • Updated docs landing page and sidebar to link to the new indexes
  • Implemented copy buttons on code blocks for easier examples

🗂️ Detailed Changes

  • created hundreds of placeholder markdown files with only a header
  • added docs/Client/classes/index.md and docs/Server/classes/index.md listing all class pages
  • enhanced index.html sidebar and JS to support copy buttons
  • tweaked CSS for the new button styles
  • linked class indexes from intro pages and main index.md

📊 Diff Stat

$ git diff --stat --cached | tail -n 5

🧪 Integration‑Test Log

Compilation succeeds with warnings:

$ git ls-files '2006Scape Client/src/main/java/*.java' -z | xargs -0 javac
3 warnings

📝 Rollback Plan

If this PR causes problems on main, revert with git revert -m 1 c2adca60093ee89b2e3b49b02e93c545f93a958a.


https://chatgpt.com/codex/tasks/task_e_6879cbf49628832b9bdc366978a2ee61

@Ddemon26 Ddemon26 merged commit 96f7b4e into master Jul 18, 2025
1 check passed
@Ddemon26 Ddemon26 deleted the codex/populate-documentation-and-set-up-index-files branch July 18, 2025 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant