Reorganize navigation, add community docs, redesign welcome page#33
Reorganize navigation, add community docs, redesign welcome page#33AntTheLimey wants to merge 2 commits intopgEdge:mainfrom
Conversation
- Add new top-level menu tabs: VM/Bare Metal, Containers, AI Toolkit, Extensions, Tools - Make pgEdge Cloud a direct link (no dropdown) - Update dropdown items with user-friendly names (Distributed CLI, Package Repository, etc.) - Add Ansible and Container Images placeholder pages - Redesign welcome page with card-based layout and improved typography - Simplify tabs.html macro to render items directly from config Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
WalkthroughAdds new documentation pages for Ansible and container images, redesigns the docs homepage with an HTML/CSS layout, restructures mkdocs navigation into new categories (VM / Bare Metal, Containers, AI Toolkit, Extensions, Tools), and simplifies nav dropdown rendering in the site template. Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip CodeRabbit can scan for known vulnerabilities in your dependencies using OSV Scanner.OSV Scanner will automatically detect and report security vulnerabilities in your project's dependencies. No additional configuration is required. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/container-images/index.md`:
- Around line 9-11: The fenced code block containing "ghcr.io/pgedge/" is
missing a language identifier; update the block in
docs/container-images/index.md to include a language token (e.g., use "text" or
"plaintext") so the block becomes ```text followed by ghcr.io/pgedge/ and
closing ``` to satisfy the linter and match other docs examples.
🧹 Nitpick comments (2)
overrides/partials/tabs.html (1)
10-36: Unusednav_itemsparameter in macro.The
dropdown_menumacro acceptsnav_itemsas a parameter (line 10), but it's never used within the macro body. This appears to be leftover from a previous implementation that cross-referenced navigation items.Proposed cleanup
-{% macro dropdown_menu(label, category_items, nav_items, dropdown_id) %} +{% macro dropdown_menu(label, category_items, dropdown_id) %}Then update the call sites (lines 54, 59, 75, 80, 85) to remove the
navargument:-{{ dropdown_menu('VM / Bare Metal', nav_categories['VM / Bare Metal'], nav, 'vm-bare-metal') }} +{{ dropdown_menu('VM / Bare Metal', nav_categories['VM / Bare Metal'], 'vm-bare-metal') }}docs/index.md (1)
7-222: Consider moving styles to the external stylesheet.There are 200+ lines of CSS embedded in this Markdown file. For maintainability and reusability, consider moving these styles to
stylesheets/extra.cssreferenced inmkdocs.yml. This would:
- Keep the Markdown file focused on content
- Allow style reuse across other pages if needed
- Make CSS changes easier to track in version control
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/container-images/index.md`:
- Around line 3-4: The docs use the abbreviation "GCR" for GitHub Container
Registry which causes confusion with Google Container Registry; update the
phrasing in the sentence containing "pgEdge publishes container images to the
GitHub Container Registry (GCR)..." to use the correct abbreviation "GHCR"
(e.g., "GitHub Container Registry (GHCR)") and ensure any other occurrences of
"GCR" in this document that refer to GitHub Container Registry are replaced with
"GHCR."
In `@docs/container-images/pulling.md`:
- Around line 46-48: Replace the indented code block containing the tag format
with an inline code span so the list item reads in one line; specifically,
change the block that shows `{postgres-version}-spock{spock-version}-{variant}`
as an indented code block to an inline backticked token within the sentence
(e.g., "...The tag takes the form `
{postgres-version}-spock{spock-version}-{variant}`") so the item is not treated
as a fenced code block and satisfies MD046.
🧹 Nitpick comments (1)
mkdocs.yml (1)
133-174: Check duplicate listings across dropdown categories.Docloader is listed under both AI Toolkit and Tools, and Vectorizer under AI Toolkit and Extensions. If the categories are meant to be mutually exclusive, consider keeping each page in a single tab to avoid redundant dropdown entries.
🧭 Optional cleanup (if tabs should be exclusive)
Extensions: - title: Spock url: spock-v5/ - title: LOLOR url: lolor/ - title: Snowflake url: snowflake/ - - title: pgEdge Vectorizer - url: pgedge-vectorizer/ @@ Tools: - title: Active Consistency Engine url: ace/ - - title: pgEdge Docloader - url: pgedge-docloader/ - title: pgEdge Anonymizer url: pgedge-anonymizer/ - title: Radar url: radar/
| pgEdge publishes container images to the GitHub Container Registry | ||
| (GCR) for deploying pgEdge components in containerized environments. |
There was a problem hiding this comment.
Use GHCR to avoid confusion with Google Container Registry.
“GCR” is commonly read as Google Container Registry; GitHub Container Registry is typically abbreviated “GHCR.”
✏️ Suggested fix
-pgEdge publishes container images to the GitHub Container Registry
-(GCR) for deploying pgEdge components in containerized environments.
+pgEdge publishes container images to the GitHub Container Registry
+(GHCR) for deploying pgEdge components in containerized environments.📝 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.
| pgEdge publishes container images to the GitHub Container Registry | |
| (GCR) for deploying pgEdge components in containerized environments. | |
| pgEdge publishes container images to the GitHub Container Registry | |
| (GHCR) for deploying pgEdge components in containerized environments. |
🤖 Prompt for AI Agents
In `@docs/container-images/index.md` around lines 3 - 4, The docs use the
abbreviation "GCR" for GitHub Container Registry which causes confusion with
Google Container Registry; update the phrasing in the sentence containing
"pgEdge publishes container images to the GitHub Container Registry (GCR)..." to
use the correct abbreviation "GHCR" (e.g., "GitHub Container Registry (GHCR)")
and ensure any other occurrences of "GCR" in this document that refer to GitHub
Container Registry are replaced with "GHCR."
| - The tag takes the form: | ||
|
|
||
| `{postgres-version}-spock{spock-version}-{variant}` |
There was a problem hiding this comment.
Inline the tag format to avoid an indented code block (MD046).
The current indentation renders as a code block; inlining keeps the list readable and satisfies the fenced‑only lint rule.
✏️ Suggested fix
-- The tag takes the form:
-
- `{postgres-version}-spock{spock-version}-{variant}`
+- The tag takes the form: `{postgres-version}-spock{spock-version}-{variant}`📝 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.
| - The tag takes the form: | |
| `{postgres-version}-spock{spock-version}-{variant}` | |
| - The tag takes the form: `{postgres-version}-spock{spock-version}-{variant}` |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
48-48: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
🤖 Prompt for AI Agents
In `@docs/container-images/pulling.md` around lines 46 - 48, Replace the indented
code block containing the tag format with an inline code span so the list item
reads in one line; specifically, change the block that shows
`{postgres-version}-spock{spock-version}-{variant}` as an indented code block to
an inline backticked token within the sentence (e.g., "...The tag takes the form
` {postgres-version}-spock{spock-version}-{variant}`") so the item is not
treated as a fenced code block and satisfies MD046.
AntTheLimey
changed the title
|
Superseded by #53 — fresh branch off current main to eliminate stale CI checks and cached merge conflicts. |
1 participant
Summary
Major restructuring of the documentation site navigation, welcome page, and addition of an AI Toolkit overview page.
Navigation Restructure
The top-level navigation tabs have been reorganized from the previous flat structure into four focused dropdowns with sub-headings and visual dividers:
Dropdown Menu Enhancements
Extended the dropdown macro to support:
Community Documentation
Added versioned documentation imports for community projects (sourced from the 3rd-party-docs repo):
AI Toolkit Overview Page
New
docs/ai-toolkit/index.mdproviding a single entry point for the AI Toolkit:Welcome Page Redesign
Other Changes
3rd-party-docsrepo (renamed frompostgresql-docs).superpowers/and community doc redirect files to.gitignoreFiles Changed
mkdocs.yml— Restructured nav_categories, added community doc imports, updated versioned_docsetsoverrides/partials/tabs.html— Extended dropdown macro with heading/HR support, restructured tab listdocs/stylesheets/extra.css— Added dropdown heading and divider stylesdocs/index.md— Complete welcome page redesigndocs/ai-toolkit/index.md— New AI Toolkit overview pagedocs/ansible/index.md— New Ansible placeholder page.gitignore— Added community doc redirect files and .superpowers/Preview
View the preview deployment at: https://feature-menu-organization.pgedge-docs.pages.dev/
Test Plan