Skip to content

docs: refresh README to reflect current addon state (#42)#43

Merged
Xerrion merged 1 commit intomasterfrom
docs/42-update-readme
Apr 29, 2026
Merged

docs: refresh README to reflect current addon state (#42)#43
Xerrion merged 1 commit intomasterfrom
docs/42-update-readme

Conversation

@Xerrion
Copy link
Copy Markdown
Owner

@Xerrion Xerrion commented Apr 29, 2026

Description

Refreshes README.md so it accurately reflects the addon as it sits on master. No source code changes - documentation only.

Highlights:

  • New Configuration section documenting /phd config and the AceConfig options panel from PR feat: add AceConfig options UI for overlay positioning (#40) #41
  • Updated Features list to mention the configurable action bar overlay
  • Added /phd config row to the slash command table; fixed the /phd (no args) row description
  • New Architecture section introducing the 4-layer Core / Engine / Data / Presentation split
  • New Development section pointing contributors at luacheck and busted
  • License link corrected from main to master

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Refactor (non-breaking change that improves code quality)
  • Documentation update
  • Breaking change (fix or feature that would cause existing functionality to change)

Related Issues

Closes #42

Testing

  • Luacheck passes (luacheck .) - no code changed, still clean
  • Tested in-game manually - N/A, docs only
  • WoW version(s) tested on: N/A - documentation only

Verification performed:

  • Visual review of rendered Markdown
  • All tables align; no em/en dashes; only ASCII hyphens
  • All claims verified against current source on master

Screenshots

N/A - Markdown documentation only.

Checklist

  • My code follows the project's code style (4-space indent, 120 char lines)
  • I have tested my changes in-game - N/A, docs only
  • Luacheck reports no warnings - no code touched
  • My commits follow conventional commit format

Documents the new /phd config slash command and AceConfig options panel from PR #41, adds a Configuration section, introduces the 4-layer architecture (Core/Engine/Data/Presentation), notes the busted test suite for contributors, and corrects the slash-command table.

Closes #42
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 29, 2026

Warning

Rate limit exceeded

@Xerrion has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 54 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 61f84dc7-962a-4f72-99ce-759a57aeeed1

📥 Commits

Reviewing files that changed from the base of the PR and between 690d9ce and 106c3f8.

📒 Files selected for processing (1)
  • README.md

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
Review rate limit: 0/1 reviews remaining, refill in 10 minutes and 54 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@Xerrion Xerrion merged commit 79c53a2 into master Apr 29, 2026
3 checks passed
@Xerrion Xerrion deleted the docs/42-update-readme branch April 29, 2026 09:32
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.

[Docs]: Update README to reflect current addon state

1 participant