Conversation
Add pagination_prev: null and pagination_next: null to the product index template to remove the next/previous footer navigation.
Both now use the same hasMeaningfulDoc filter, ensuring methods in the table always have corresponding entries in the Method Reference section below.
HTML tags in PHPDoc descriptions (like <select>, <button>, <script>) were being interpreted as actual HTML by Docusaurus, breaking the page rendering and causing method sections to be truncated. Added HTML escaping to: - mdEscape() for table cells - htmlEscape() helper for inline markdown content - Class summaries and descriptions - Method summaries and descriptions - Function summaries and descriptions - Deprecated tag descriptions - Class/function index page summaries Fixes 60+ broken anchor warnings caused by page truncation.
Add descriptions, purchaseUrls, titles, and category metadata to enable dynamic rendering across home page and navbar.
- Read product data from repos-config.json - Group products by category with proper ordering - Add Third Party section for isThirdParty products - Show product icons for all sections
- Create custom ProductLearnMoreLink navbar component - Add UTM tracking parameters to purchase URLs - Reorder menus: GravityKit Products before GravityView - Style navbar button with proper spacing
Add SVG icons for all products, renamed to match product IDs. Remove deprecated icon files with inconsistent naming.
Remove old icon files with inconsistent naming conventions.
Expand configuration section with full schema documentation including purchaseUrl and category configuration options.
Only show Functions link and count in API index when there are functions to display. Adds pagination_prev/next: null to index.
|
Caution Review failedThe pull request is closed. WalkthroughThis PR restructures the product catalog and navigation system from a flat, hard-coded architecture to a categorized, configuration-driven system. It introduces a new GravityKit category in repos-config.json, enriches product metadata with descriptions and purchase URLs, and refactors navigation and homepage components to dynamically render content from centralized configuration. Supporting changes include HTML escaping for markdown safety and new navbar styling. Changes
Sequence DiagramsequenceDiagram
participant User
participant Navbar
participant DocConfig as docusaurus.config.js
participant ReposConfig as repos-config.json
participant ProductLink as ProductLearnMoreLink
participant Page as Homepage
User->>Navbar: Load site
Navbar->>DocConfig: Request navigation structure
DocConfig->>ReposConfig: Fetch categories & products
ReposConfig-->>DocConfig: Return category/product metadata
DocConfig->>Navbar: Render categorized dropdowns
Navbar-->>User: Display navigation with GravityView & GravityKit dropdowns
User->>Page: Navigate to homepage
Page->>ReposConfig: Fetch all categories
ReposConfig-->>Page: Return sorted categories
Page->>ReposConfig: Fetch products by category
ReposConfig-->>Page: Return filtered products
Page->>Page: Render ProductSections dynamically
Page-->>User: Display categorized product grid
User->>ProductLink: Click "Learn More" link
ProductLink->>ReposConfig: Lookup product by ID
ReposConfig-->>ProductLink: Return purchaseUrl & metadata
ProductLink->>ProductLink: Append UTM parameters
ProductLink-->>User: Navigate to purchase page
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
repos-config.jsonChanges
Configuration
repos-config.json: Add descriptions, purchaseUrls, titles, and category metadataHome Page
src/pages/index.js: Refactored to read from centralized configisThirdPartyproductsNavbar
src/theme/NavbarItem/ProductLearnMoreLink.js: Dynamic button based on current pagesrc/theme/NavbarItem/ComponentTypes.js: Register custom navbar componentdocusaurus.config.js: Reorder menus, GravityKit Products firstsrc/css/custom.css: Button styling with proper spacingAssets
Documentation
README.md: Document repos-config.json schema and categoriesBug Fix
scripts/generate-php-api.mjs: Hide functions section when no functions documentedTest plan
Summary by CodeRabbit
Release Notes
New Features
Documentation
Style
✏️ Tip: You can customize this high-level summary in your review settings.