Skip to content

Refine Custom Post Types add-on documentation - #81

Merged
bkatusic merged 3 commits into
mainfrom
docs-review/custom-post-types-extension
Jun 25, 2026
Merged

bkatusic merged 3 commits into
mainfrom
docs-review/custom-post-types-extension

Conversation

@bkatusic

@bkatusic bkatusic commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updated the Custom Post Types add-on page to match current MainWP Dashboard terminology and navigation.
  • Cleaned up copy for clarity and consistency, including product naming, step text, and action labels.
  • Aligned add-on metadata with the current purchase URL, version, and description.

Testing

  • Not run (not requested)

Summary by CodeRabbit

  • Documentation
    • Updated the Custom Post Types guide to match the latest MainWP navigation and UI wording.
    • Refreshed add-on metadata and description text.
    • Clarified setup, matching, bulk edit, and delete instructions for custom post type posts.
    • Added clearer guidance on managing existing CPTs, Dashboard site requirements, and when the Delete action becomes available.

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The Custom Post Types extension MDX guide was updated with new metadata, revised wording, and current MainWP navigation paths across the create, manage, view, delete, and bulk edit instructions.

Changes

Custom Post Types Extension Docs

Layer / File(s) Summary
Metadata and setup wording
add-ons/posts-pages/custom-post-types-extension.mdx
Updated the add-on metadata block, intro description, CPT matching guidance, and CPT registration wording.
Create and manage CPT posts
add-ons/posts-pages/custom-post-types-extension.mdx
Updated the create-post walkthrough and the manage-posts section to use the newer MainWP Dashboard navigation and step wording.
Edit and view CPT posts
add-ons/posts-pages/custom-post-types-extension.mdx
Updated the edit and view walkthroughs to use the current Manage Posts navigation and the Show Posts and View action labels.
Trash, delete, and bulk edit flows
add-ons/posts-pages/custom-post-types-extension.mdx
Updated the trash/delete walkthroughs and the bulk edit instructions, including the Delete-after-Trash note and child-site selection wording.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 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 clearly and concisely describes the main change: refining the Custom Post Types add-on documentation.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-review/custom-post-types-extension

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

@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/posts-pages/custom-post-types-extension.mdx`:
- Line 89: The navigation path uses an inconsistent menu label, with Custom Post
Type differing from the extension name used elsewhere. Update the Step content
in custom-post-types-extension.mdx to match the established label Custom Post
Types, so the path aligns with the menu naming used across the docs.
🪄 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: d775c12c-a86a-4db8-9f1b-a2c8384647f2

📥 Commits

Reviewing files that changed from the base of the PR and between 5049900 and 5e6efda.

📒 Files selected for processing (1)
  • add-ons/posts-pages/custom-post-types-extension.mdx

<Step title="Log in to your MainWP Dashboard">
</Step>
<Step title="Go to the MainWP > Add-ons > Custom Post Types page">
<Step title="Go to MainWP Dashboard > Add-ons > Administrative > Custom Post Type">

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

Use consistent menu label in the navigation path.

At Line 89, ... > Custom Post Type is inconsistent with the extension/menu naming used elsewhere (Custom Post Types). This can cause users to look for the wrong item.

Suggested fix
-<Step title="Go to MainWP Dashboard > Add-ons > Administrative > Custom Post Type">
+<Step title="Go to MainWP Dashboard > Add-ons > Administrative > Custom Post Types">
📝 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
<Step title="Go to MainWP Dashboard > Add-ons > Administrative > Custom Post Type">
<Step title="Go to MainWP Dashboard > Add-ons > Administrative > Custom Post Types">
🤖 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/posts-pages/custom-post-types-extension.mdx` at line 89, The
navigation path uses an inconsistent menu label, with Custom Post Type differing
from the extension name used elsewhere. Update the Step content in
custom-post-types-extension.mdx to match the established label Custom Post
Types, so the path aligns with the menu naming used across the docs.

@bkatusic
bkatusic merged commit 9c2a496 into main Jun 25, 2026
3 checks passed
@bkatusic
bkatusic deleted the docs-review/custom-post-types-extension branch June 25, 2026 15:54
@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mainwp 🔴 Failed Jun 25, 2026, 4:05 PM

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