Skip to content

docs: add GravityView 3.0 beta migration guide#3

Open
crbdev wants to merge 1 commit intomainfrom
docs/gravityview-3.0-migration-guide
Open

docs: add GravityView 3.0 beta migration guide#3
crbdev wants to merge 1 commit intomainfrom
docs/gravityview-3.0-migration-guide

Conversation

@crbdev
Copy link
Copy Markdown

@crbdev crbdev commented Apr 23, 2026

Summary

Adds a developer migration guide for GravityView 3.0 at /migrating-to-3-0-dev-guide/ and links it from the Resources column in the site footer.

The guide covers:

  • PSR-4 namespace refactor (GravityKit\GravityView\*) and the two-layer autoloader
  • New WordPress 5.5 minimum
  • File system changes (templates/field types/widgets no longer require a physical file)
  • New Contracts\*Interface surface
  • Full legacy → replacement class/hook mapping tables
  • Troubleshooting and a pre-upgrade checklist

Files changed

  • src/pages/migrating-to-3-0-dev-guide.md — new standalone page
  • docusaurus.config.js — footer link added to the Resources column

Edits already applied to the draft

  • Reworded the "before beta ships" admonitions to reflect that 3.0 is currently in beta
  • Softened the opening note from "No runtime behavior changes" → "Mostly structural, with two caveats" (surfaces the get_class() break and File system changes up front)
  • Routed all error-reporting references to support@gravitykit.com for consistency
  • Corrected the count of 2.55-deprecated hooks (was "roughly 30", actual ≥40 on feature/3.0-styles)
  • Trimmed a few AI-patterned em dashes in the intro

Open questions

Three items need engineering/support input before publication — see PR comments:

  • Hook-count framing in the "New hooks in 3.0" section (diff between develop and feature/3.0-styles shows zero net-new gk/gravityview/* hooks)
  • Rollback guidance — missing, likely valuable for beta testers
  • Add-on compatibility matrix — missing, needs per-product min-version data

Test plan

  • Visit /migrating-to-3-0-dev-guide/ locally (npm start) and confirm it renders
  • Confirm the "GravityView 3.0 beta migration guide" link appears in the Resources footer and resolves to the page
  • Skim tables/admonitions for rendering issues

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive GravityView 3.0 migration guide covering namespace changes, legacy class mappings, hook deprecations, and troubleshooting information
    • Updated footer navigation to provide quick access to the migration guide

Adds a standalone page at /migrating-to-3-0-dev-guide/ covering the PSR-4
namespace refactor, raised WP/PHP minimums, file system changes, and the
legacy → replacement hook mapping. Links from the Resources footer.

Open questions on hook-count framing, rollback guidance, and an add-on
compatibility matrix are flagged as PR comments for engineering/support
review before publication.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

Walkthrough

A new GravityView 3.0 migration guide is added to the documentation, with a corresponding footer navigation link configured in the site configuration. The guide documents namespace refactoring, minimum version requirements, deprecated features, and step-by-step migration instructions for developers.

Changes

Cohort / File(s) Summary
Documentation Configuration
docusaurus.config.js
Added footer navigation link routing to the new GravityView 3.0 beta migration guide under the Resources section.
Migration Guide
src/pages/migrating-to-3-0-dev-guide.md
New comprehensive developer migration guide covering PSR-4 namespace consolidation under GravityKit\GravityView\*, Composer autoload behavior, minimum platform versions, deprecated hooks with replacements, legacy-to-new namespace mappings, code migration examples, and troubleshooting sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 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 'docs: add GravityView 3.0 beta migration guide' directly and clearly describes the main change: adding comprehensive documentation for GravityView 3.0 migration.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/gravityview-3.0-migration-guide

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

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


## New hooks in 3.0

The 3.0 release cycle added roughly 80 new `gk/gravityview/*` hooks. A non-exhaustive list of the most useful ones:
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Hook-count framing — needs decision

Claim on this line: "The 3.0 release cycle added roughly 80 new gk/gravityview/* hooks."

Branch diff for verification:

  • origin/develop (2.x): 64 unique gk/gravityview/* hooks
  • origin/feature/3.0-styles (3.0): 63 unique gk/gravityview/* hooks
  • Net new in 3.0: zero. One (gk/gravityview/admin/widget-info) was removed.

The gk/gravityview/* namespace was introduced around 2.55 as replacements for the legacy gravityview_* hooks; 3.0 keeps them intact but doesn't add new ones.

Two directions to pick from:

  1. Reframe the section as "The gk/gravityview/* hook namespace" with a lead like "GravityView exposes over 60 hooks under this namespace, most introduced in 2.55; 3.0 keeps them intact. The most useful:"
  2. Clarify the intent — is "new in 3.0" meant to include something the grep missed (new parameters on existing hooks, new docblock coverage, etc.)?

GravityView team: which direction?

@crbdev
Copy link
Copy Markdown
Author

crbdev commented Apr 23, 2026

Missing: rollback guidance

The guide doesn't cover downgrade safety. During the beta, if a site owner upgrades to 3.0-beta and hits an edge case, can they safely downgrade to 2.x without data loss, option corruption, or broken Views?

A short paragraph under "Before you upgrade" along the lines of:

If 3.0 causes issues in your environment, you can safely downgrade to 2.x. Views, entries, approvals, and settings are preserved because [reason]. [Procedure: deactivate, replace plugin files with 2.x ZIP, reactivate — or whatever's accurate].

…would pre-empt a significant number of support tickets during the beta.

Needs input from:

  • Engineering — what's actually safe to roll back from 3.0-beta to the latest 2.x? Any option keys, post-meta, or DB state that would cause problems on downgrade?
  • Support — do you want a specific procedure documented, or a "contact support before downgrading" callout?

@crbdev
Copy link
Copy Markdown
Author

crbdev commented Apr 23, 2026

Missing: add-on compatibility matrix

For site owners running GravityView alongside commercial add-ons, the first question is: "Which versions of my add-ons work with 3.0?"

Suggested addition near the bottom of the guide:

Add-on Min version for 3.0
Advanced Filter ?
Multiple Forms ?
Maps ?
DataTables ?
Ratings & Reviews ?
A-Z Filters ?
Featured Entries ?
GravityEdit ?
GravityCalendar ?
GravityCharts ?
GravityMath ?
GravityImport ?
GravityExport ?
... ...

Alternative: link out to a separate "GravityView 3.0 add-on compatibility" page that's easier to keep updated than an inline table as each add-on ships its 3.0-compatible release.

Needs input from:

  • Engineering / product — per-product min-version data, or confirmation of which add-ons already have 3.0-compatible releases out / planned
  • Product — do we want an inline table here, or a separate continually-updated page?

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@src/pages/migrating-to-3-0-dev-guide.md`:
- Around line 530-531: The sentence "The 3.0 release cycle added roughly 80 new
`gk/gravityview/*` hooks." should not publish an unverified numeric claim;
either verify the exact count and include a citation or change the wording to a
non-quantitative statement. Locate the string "The 3.0 release cycle added
roughly 80 new `gk/gravityview/*` hooks." and either replace it with a verified,
cited count (e.g., "The 3.0 release added X new `gk/gravityview/*` hooks
(source: <cite>)") or a neutral phrasing such as "The 3.0 release added many new
`gk/gravityview/*` hooks" until you can confirm and cite the exact number.
🪄 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: b96123f3-ab58-4a57-9730-cd2f5f957790

📥 Commits

Reviewing files that changed from the base of the PR and between 4684ed8 and 37ee7c2.

📒 Files selected for processing (2)
  • docusaurus.config.js
  • src/pages/migrating-to-3-0-dev-guide.md

Comment on lines +530 to +531
The 3.0 release cycle added roughly 80 new `gk/gravityview/*` hooks. A non-exhaustive list of the most useful ones:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Avoid publishing an unverified hook-count claim.
This numeric framing is currently marked as an open question in the PR context. Please either verify and cite the exact count, or use non-quantitative wording until confirmed.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/pages/migrating-to-3-0-dev-guide.md` around lines 530 - 531, The sentence
"The 3.0 release cycle added roughly 80 new `gk/gravityview/*` hooks." should
not publish an unverified numeric claim; either verify the exact count and
include a citation or change the wording to a non-quantitative statement. Locate
the string "The 3.0 release cycle added roughly 80 new `gk/gravityview/*`
hooks." and either replace it with a verified, cited count (e.g., "The 3.0
release added X new `gk/gravityview/*` hooks (source: <cite>)") or a neutral
phrasing such as "The 3.0 release added many new `gk/gravityview/*` hooks" until
you can confirm and cite the exact number.

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.

2 participants