Skip to content

Update Dashboard Lock extension docs for new add-on path and lock behavior - #87

Merged
bkatusic merged 1 commit into
mainfrom
docs-review/dashboard-lock-extension
Jul 6, 2026
Merged

bkatusic merged 1 commit into
mainfrom
docs-review/dashboard-lock-extension

Conversation

@bkatusic

@bkatusic bkatusic commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Update the Dashboard Lock docs to point to the new /add-on/dashboard-lock/ URL and refresh the version metadata to 5.1
  • Align the setup steps with the current MainWP Dashboard navigation under Add-ons > Security > Dashboard Lock
  • Clarify redirect-rule exclusions and expand the lock removal description

Testing

  • Not run (not requested)

Summary by CodeRabbit

  • Documentation
    • Updated Dashboard Lock instructions to match the latest add-on URL and version details.
    • Revised navigation steps so users now find Dashboard Lock under MainWP > Add-ons > Security > Dashboard Lock.
    • Simplified frontend redirect guidance with clearer skip behavior and updated exemption instructions.
    • Refreshed unlock and IP restriction steps with updated wording and formatting.

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This PR updates the Dashboard Lock documentation page: the add-on URL path changes from /extension/ to /add-on/, the embedded version bumps to 5.1, navigation steps are reworded to reference MainWP > Add-ons > Security > Dashboard Lock, redirect notes are simplified, and unlock instructions and an .htaccess marker are updated.

Changes

Dashboard Lock documentation update

Layer / File(s) Summary
Add-on URL/version and navigation labels
add-ons/security/dashboard-lock-extension.mdx
Updates the add-on listing URL to /add-on/, bumps version to 5.1, and updates step navigation titles across multiple sections to reference MainWP > Add-ons > Security > Dashboard Lock.
Redirect notes and unlock instructions
add-ons/security/dashboard-lock-extension.mdx
Replaces WP-Cron/REST API exclusion notes with a simplified statement, rewrites the Unlock MainWP Dashboard section, and reformats the .htaccess marker comment.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • mainwp/docs#22: Both PRs migrate add-on documentation links from the /extension/... format to the new /add-on/... path, along with related version/navigation wording updates.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the documentation update for the new add-on path and lock behavior changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-review/dashboard-lock-extension

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

@mintlify

mintlify Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mainwp 🟢 Ready View Preview Jul 6, 2026, 1:13 PM

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@add-ons/security/dashboard-lock-extension.mdx`:
- Line 230: The lock recovery instructions currently inline the .htaccess marker
text, which makes the exact removal target easy to miss. Update the content
around the Dashboard Lock Extension marker guidance to present the start/end
marker and replacement text as a literal fenced snippet instead of plain prose.
Keep the wording in the same section that references the Dashboard Lock
Extension so the exact marker remains easy to copy and use.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8ebf643e-f61c-40a6-a117-442bffd7f9ac

📥 Commits

Reviewing files that changed from the base of the PR and between 7f63cf8 and 1b84c35.

📒 Files selected for processing (1)
  • add-ons/security/dashboard-lock-extension.mdx

</Step>
<Step title="Remove the code inserted by the Dashboard Lock Extension">
Remove the code inserted by the Dashboard Lock Extension \# BEGIN MainWP Secure and Clean // remove code from here # END MainWP Secure and Clean
Remove the code inserted by the Dashboard Lock Extension \# BEGIN MainWP Secure and Clean. // remove code from here # END MainWP Secure and Clean.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Keep the .htaccess marker in a literal block.

Inlining the start/end marker text makes it easier to miss or miscopy the exact removal target during lock recovery. A fenced snippet would be clearer and less error-prone.

♻️ Suggested formatting
-Remove the code inserted by the Dashboard Lock Extension \# BEGIN MainWP Secure and Clean. // remove code from here # END MainWP Secure and Clean.
+Remove the code inserted by the Dashboard Lock Extension:
+
+```htaccess
+# BEGIN MainWP Secure and Clean
+// remove code from here
+# END MainWP Secure and Clean
+```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Remove the code inserted by the Dashboard Lock Extension \# BEGIN MainWP Secure and Clean. // remove code from here # END MainWP Secure and Clean.
Remove the code inserted by the Dashboard Lock Extension:
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@add-ons/security/dashboard-lock-extension.mdx` at line 230, The lock recovery
instructions currently inline the .htaccess marker text, which makes the exact
removal target easy to miss. Update the content around the Dashboard Lock
Extension marker guidance to present the start/end marker and replacement text
as a literal fenced snippet instead of plain prose. Keep the wording in the same
section that references the Dashboard Lock Extension so the exact marker remains
easy to copy and use.

@bkatusic
bkatusic merged commit 310858e into main Jul 6, 2026
5 checks passed
@bkatusic
bkatusic deleted the docs-review/dashboard-lock-extension branch July 6, 2026 13:15
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.

1 participant