Updating screenshots and some text content for cloud-227 #32
Conversation
WalkthroughDocs-only updates across pgEdge Cloud: broad copy reflows and UI text edits; added VPC Associations and CPU metric doc entries; unified backup scheduling and PostgreSQL version selector text; clarified backup-store and resource-tag guidance; removed several edition-restriction notes and deleted multiple pages; mkdocs navigation updated. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Important Action Needed: IP Allowlist UpdateIf your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:
Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist. Comment |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation Review - PR #32
Thank you for updating the documentation and screenshots for cloud-227. The changes generally align well with the pgEdge stylesheet requirements.
✅ Strengths
- Line wrapping: Properly implemented at 79 characters while keeping inline markdown links intact
- Active voice: Maintained throughout with grammatically correct sentences
- Formatting: Correct use of backticks for code elements, proper article usage, and bulleted list spacing
- Punctuation fix: Corrected the space before semicolon in the PostgreSQL port description (line 112 in create_cluster.md)
- Content reorganization: Moving the PostgreSQL Version field earlier in create_db.md improves logical flow
⚠️ Issues to Address
1. Indentation Error in create_cluster.md (around line 22)
The continuation line has incorrect leading spaces:
Next, select up to 5 availability zones in any regions to which you have access.
To use the map for location selection, use the `Show map` toggle to enable
the map.This should either:
- Be part of a bulleted list item (if that's the intent), OR
- Start at the left margin without leading spaces
Recommendation: Remove the leading spaces on line 22 unless this is meant to be a sub-bullet.
📋 Other Observations
- Security: No issues found in examples or documented code
- Links: All external links properly use docs.pgedge.com (no github.io links)
- Screenshots: Seven PNG files updated - ensure they accurately reflect current UI
- Content removed: The "Implementing a Backup Strategy" section header was removed from create_db.md, which appears intentional for better flow
Summary
The changes improve documentation readability and align with the stylesheet. Please address the indentation issue in create_cluster.md before merging.
![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/cloud/cluster/create_cluster.md`:
- Around line 108-135: The nested list indentation under the "Firewall Rules"
section is using 4 spaces for sub-bullets (e.g., the nested items under "Use the
`Type` drop-down..." and "Use the `Sources` drop-down..."); change those nested
bullet lines to use 2-space indentation so all sub-items (the
PostgreSQL/HTTPS/SSH bullets and the My IP/All IPV4 bullets) are indented by 2
spaces and use consistent list markers to satisfy markdownlint.
🧹 Nitpick comments (2)
docs/cloud/database/create_db.md (1)
20-36: Editorial improvements enhance readability.The paragraph reflows and formatting adjustments improve consistency. Optionally, consider varying the structure of the bullet points on lines 32-36 to avoid repetitive sentence patterns (each starts with a region name followed by "offers"), though the current version is clear and functional.
docs/cloud/cluster/create_cluster.md (1)
16-18: Consider simplifying terminology.The reflow improves readability. Optionally, "drop-down listbox" could be simplified to "drop-down list" or just "drop-down" for more concise and standard terminology.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
docs/cloud/images/cluster_regions.pngis excluded by!**/*.pngdocs/cloud/images/configure_network.pngis excluded by!**/*.pngdocs/cloud/images/create_new_db.pngis excluded by!**/*.pngdocs/cloud/images/firewall_rules.pngis excluded by!**/*.pngdocs/cloud/images/resource_tag_add.pngis excluded by!**/*.pngdocs/cloud/images/select_additional_options.pngis excluded by!**/*.pngdocs/cloud/images/vpc_association.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/cloud/cluster/create_cluster.mddocs/cloud/database/create_db.md
🧰 Additional context used
🪛 LanguageTool
docs/cloud/cluster/create_cluster.md
[grammar] ~16-~16: Ensure spelling is correct
Context: ..._cluster_name.png) * Use the drop-down listbox in the Cloud Account field to select ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~48-~48: Consider using “inaccessible” to avoid wordiness.
Context: ...net. * Private network clusters are not accessible from the public internet. Note that...
(NOT_ABLE_PREMIUM)
[style] ~154-~154: This phrase is redundant. Consider using “outside”.
Context: ...DNS names and records that you create outside of the pgEdge console. * a single-purpose,...
(OUTSIDE_OF)
docs/cloud/database/create_db.md
[style] ~35-~35: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...est Coast configuration. * Global offers servers on the West Coast, in Frankfurt...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~57-~57: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3555 characters long)
Context: ...mizing-backup-details-for-pgbackrest). !!! note You cannot modify a backup co...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
docs/cloud/cluster/create_cluster.md
116-116: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
119-119: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
127-127: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
129-129: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Cloudflare Pages
🔇 Additional comments (14)
docs/cloud/database/create_db.md (6)
3-6: Editorial improvements look good.The paragraph reflow improves readability while maintaining the original meaning.
12-19: Good addition of PostgreSQL version selection.The reflow of the display name description and the addition of the PostgreSQL version selection step both improve the documentation clarity and completeness.
42-56: Backup configuration section improvements approved.The reflow of the backup configuration details improves line wrapping and readability while preserving all technical information.
60-61: Note formatting improved.The multiline formatting of the backup configuration constraint improves readability.
65-82: Options section formatting looks good.The consistent line wrapping and formatting of each toggle switch option improves the documentation structure and readability.
83-87: Closing paragraph reflow approved.The formatting adjustment maintains clarity while improving line wrapping consistency.
docs/cloud/cluster/create_cluster.md (8)
5-10: Opening section improvements approved.The paragraph reflows improve consistency and readability while maintaining all necessary information about prerequisites and initial steps.
22-32: Region and zone selection formatting improved.The paragraph reflows enhance readability and maintain clear instructions for region and availability zone selection.
34-50: Network settings section formatting looks good.The reflows improve the presentation of network configuration options, making the distinction between public and private networks clearer.
58-70: Deployment details formatting approved.The consistent line wrapping across instance type, volume size, and SSH key descriptions improves documentation structure.
72-81: Backup stores section formatting improved.The paragraph reflows enhance readability while maintaining all important information about backup store selection.
83-104: Resource tags and VPC associations formatting approved.The reflows improve the presentation of these advanced configuration options while maintaining clarity.
139-156: Deployment options formatting approved.The reflows improve the presentation of the firewall rules option and single-database cluster benefits while maintaining clarity.
158-168: Closing section formatting looks good.The reflows improve the presentation of the final deployment steps and troubleshooting reference.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
Deploying pgedge-docs with
|
| Latest commit: |
f61a872
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://860321c7.pgedge-docs.pages.dev |
| Branch Preview URL: | https://cloud-227.pgedge-docs.pages.dev |
There was a problem hiding this comment.
Documentation Review
I've reviewed this PR against the project stylesheet (pgedge_stylesheet.md) and overall documentation quality standards. The changes improve readability and update screenshots to match current UI.
✅ Strengths
Line Length Compliance: The rewrapping to 79 characters is consistently applied throughout both files, which aligns with the stylesheet requirement. Markdown links are properly kept on single lines.
Screenshot Updates: All 8 updated screenshots reflect current UI state, which improves documentation accuracy.
Content Improvements:
- Simplified info note in
create_cluster.md(removed redundant Enterprise Edition reference) - Removed Developer Edition sections in
create_db.mdthat may no longer be applicable - Changed "PostgreSQL" to "Postgres" in
create_db.md:56for consistency
⚠️ Issues Found
Stylesheet Violations
1. Missing blank lines before lists (stylesheet line 21)
In create_cluster.md:144-147, the bulleted list lacks a blank line before the first item:
Single database clusters are beneficial because:
* they allow connections to the database with an IP address (rather than byShould have a blank line after "because:" and before the first bullet.
2. Sentence length violations (stylesheet line 10: "7-20 words")
Several sentences exceed the 20-word limit:
create_db.md:2-5(43 words)create_db.md:12-15(25 words)create_cluster.md:27-30(25 words)create_cluster.md:64-67(24 words)create_cluster.md:82-86(27 words)
Consider using semi-colons to break these into shorter, linked sentences.
3. Contractions (stylesheet line 11: "full and grammatically correct sentences")
In create_cluster.md:141, "you'll" should be "you will" for formal documentation.
4. Space before punctuation
In create_db.md:35, there's a trailing space before the period:
icon (a pencil) in the upper-right corner to modify backup settings. The Content Issues
5. Inconsistent link formatting
In create_cluster.md:71-72:
Optionally, select the
[backup stores](https://docs.pgedge.com/cloud/backup/backup_store)The link is split across lines unnecessarily. Per stylesheet line 7, links should stay on one line even if it exceeds 79 characters.
6. Removed heading structure
In create_db.md, the sections "Implementing a Backup Strategy" and "Additional Database Installation Options" were removed as bold text/headers. This reduces navigability. Consider whether section structure should be preserved.
📋 Recommendations
- Add blank lines before all bulleted lists
- Break long sentences using semi-colons (7-20 word guideline)
- Keep markdown links on single lines (don't wrap them)
- Remove trailing spaces
- Change "you'll" to "you will"
- Consider if removed Developer Edition content should be documented elsewhere
Security & Code Quality
No security issues identified. No code examples present in these documentation changes.
Overall, this is a solid documentation improvement that enhances readability and updates visuals. The line wrapping work is excellent. Addressing the stylesheet violations above would make it fully compliant.
There was a problem hiding this comment.
Documentation Review for PR #32
I've reviewed this PR against the pgEdge stylesheet (pgedge_stylesheet.md) and checked for security issues and code quality. Overall, the changes improve readability by wrapping lines to 79 characters as required. However, there are several stylesheet violations that need attention.
✅ Positive Changes
- Line wrapping: All documentation now correctly wraps to 79 characters while keeping inline markdown links on single lines (stylesheet requirement)
- Content cleanup: Removed outdated Developer Edition references, streamlining the documentation
- Screenshot updates: Updated images to reflect current UI
- No security issues: No SQL injection, authentication bypasses, or other security concerns in the examples
❌ Stylesheet Violations
1. Bold font in section headings (docs/cloud/index.md:7-37)
The stylesheet explicitly states: "Do not use bold font bullet items" (line 23).
The "Fully distributed PostgreSQL Made Easy" section uses bold formatting for feature headings:
**Multi-Region and Multi-Cloud:**→ Should beMulti-Region and Multi-Cloud:**Easy Deployment:**→ Should beEasy Deployment:**Control and Monitoring:**→ Should beControl and Monitoring:- And 5 more instances
These should be plain text with colons, not bold.
2. Missing bulleted list formatting (docs/cloud/index.md:7-37)
According to the stylesheet (line 19-24), after an introductory sentence, features should be formatted as a bulleted list with:
- A blank line before the first item
- Complete sentences with articles for each entry
Current format:
## Fully distributed PostgreSQL Made Easy
Multi-Region and Multi-Cloud: Deploy nodes...Should be:
## Fully distributed PostgreSQL Made Easy
The pgEdge Cloud platform includes the following features:
* Multi-Region and Multi-Cloud: Deploy nodes across multiple cloud provider regions...
* Easy Deployment: Creation and deployment of Cloud clusters is a breeze...3. Incomplete sentence at end of file (docs/cloud/index.md:50)
The file ends abruptly with no closing sentence. The stylesheet requires complete sentences. Consider adding back a closing statement similar to the original (but without the typo "pgEdgepgEdge").
4. Missing blank line before image (docs/cloud/cluster/create_cluster.md:97)
The stylesheet requires blank lines before list items (line 21). There should be a blank line before the image at line 97.
5. Active voice consistency (docs/cloud/database/create_db.md:35)
The phrase "select the `edit` icon (a pencil)" could be more active: "Select the `edit` icon (a pencil)..." (capitalize to start the sentence properly).
📝 Minor Suggestions
-
docs/cloud/cluster/create_cluster.md:124: "Select `PostgreSQL` to create a connection to port `5432`" - The semicolon before "this is" could be replaced with a period for better sentence structure.
-
docs/cloud/database/create_db.md:36: Trailing space after "The" on line 36 should be removed.
-
mkdocs.yml: The commented-out line for Developer Edition is fine for now, but consider removing it entirely in a future cleanup PR if it's permanently deprecated.
🔍 No Issues Found
- ✅ No security vulnerabilities in code examples
- ✅ Proper use of backticks for inline code
- ✅ Links formatted correctly
- ✅ Image alt text updated appropriately
- ✅ Proper use of articles (a, an, the)
Summary
The line wrapping and content updates are excellent improvements. The main issues are formatting-related:
- Remove bold formatting from feature headings in
docs/cloud/index.md - Convert feature descriptions to proper bulleted list format
- Add a closing sentence to
docs/cloud/index.md - Minor formatting cleanup
These changes will bring the documentation into full compliance with the stylesheet.
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@docs/cloud/index.md`:
- Around line 3-4: Change the compound adjective "single node" to "single-node"
in the sentence containing the phrase "pgEdge Cloud offers single node or
fully-distributed PostgreSQL" so it reads "pgEdge Cloud offers single-node or
fully-distributed PostgreSQL"; update the corresponding text in
docs/cloud/index.md at the phrase to ensure consistent hyphenation.
- Around line 37-39: Update the sentence containing the phrase "Edge Platform
Integration: Cloud is especially well suited for use with edge development
platforms..." to hyphenate the compound adjective by changing "well suited" to
"well-suited" so it reads "Cloud is especially well-suited for use with..." to
fix the grammar; locate the string in docs/cloud/index.md and make the
single-word change in that line.
In `@mkdocs.yml`:
- Line 334: The commented navigation line referencing de_getting_started.md
leaves that document orphaned; either remove the unused file
docs/cloud/getting_started/de_getting_started.md if Developer Edition is
removed, or restore the navigation by uncommenting the line "- Developer
Edition: cloud/getting_started/de_getting_started.md" in mkdocs.yml (ensuring
the path matches the file name de_getting_started.md) so the page is
discoverable; choose and apply one of these actions and update mkdocs.yml
accordingly.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/cloud/index.mdmkdocs.yml
🧰 Additional context used
🪛 LanguageTool
docs/cloud/index.md
[grammar] ~3-~3: Use a hyphen to join words.
Context: ...loud Edition pgEdge Cloud offers single node or fully-distributed PostgreSQL, de...
(QB_NEW_EN_HYPHEN)
[grammar] ~37-~37: Use a hyphen to join words.
Context: ...rm Integration: Cloud is especially well suited for use with edge development pla...
(QB_NEW_EN_HYPHEN)
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (1)
docs/cloud/index.md (1)
1-49: LGTM on the formatting improvements.The text rewrapping and readability improvements look good. The content is well-structured and clearly presents pgEdge Cloud's features.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| pgEdge Cloud offers single node or fully-distributed PostgreSQL, deployable | ||
| across multiple cloud regions or data centers. |
There was a problem hiding this comment.
Minor grammar: hyphenate compound adjective.
Per static analysis, "single node" should be hyphenated when used as a compound adjective before a noun.
📝 Suggested fix
-pgEdge Cloud offers single node or fully-distributed PostgreSQL, deployable
+pgEdge Cloud offers single-node or fully-distributed PostgreSQL, deployable
across multiple cloud regions or data centers.📝 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 Cloud offers single node or fully-distributed PostgreSQL, deployable | |
| across multiple cloud regions or data centers. | |
| pgEdge Cloud offers single-node or fully-distributed PostgreSQL, deployable | |
| across multiple cloud regions or data centers. |
🧰 Tools
🪛 LanguageTool
[grammar] ~3-~3: Use a hyphen to join words.
Context: ...loud Edition pgEdge Cloud offers single node or fully-distributed PostgreSQL, de...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/cloud/index.md` around lines 3 - 4, Change the compound adjective
"single node" to "single-node" in the sentence containing the phrase "pgEdge
Cloud offers single node or fully-distributed PostgreSQL" so it reads "pgEdge
Cloud offers single-node or fully-distributed PostgreSQL"; update the
corresponding text in docs/cloud/index.md at the phrase to ensure consistent
hyphenation.
docs/cloud/index.md
Outdated
| Edge Platform Integration: Cloud is especially well suited for use with | ||
| edge development platforms and software such as Cloudflare Workers, Terraform, | ||
| Vercel, and Fastly. |
There was a problem hiding this comment.
Minor grammar: hyphenate compound adjective.
Per static analysis, "well suited" should be hyphenated when used as a compound adjective.
📝 Suggested fix
-Edge Platform Integration: Cloud is especially well suited for use with
+Edge Platform Integration: Cloud is especially well-suited for use with
edge development platforms and software such as Cloudflare Workers, Terraform,
Vercel, and Fastly.📝 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.
| Edge Platform Integration: Cloud is especially well suited for use with | |
| edge development platforms and software such as Cloudflare Workers, Terraform, | |
| Vercel, and Fastly. | |
| Edge Platform Integration: Cloud is especially well-suited for use with | |
| edge development platforms and software such as Cloudflare Workers, Terraform, | |
| Vercel, and Fastly. |
🧰 Tools
🪛 LanguageTool
[grammar] ~37-~37: Use a hyphen to join words.
Context: ...rm Integration: Cloud is especially well suited for use with edge development pla...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/cloud/index.md` around lines 37 - 39, Update the sentence containing the
phrase "Edge Platform Integration: Cloud is especially well suited for use with
edge development platforms..." to hyphenate the compound adjective by changing
"well suited" to "well-suited" so it reads "Cloud is especially well-suited for
use with..." to fix the grammar; locate the string in docs/cloud/index.md and
make the single-word change in that line.
mkdocs.yml
Outdated
| - Getting Started: | ||
| - Enterprise Edition: cloud/getting_started/ee_getting_started.md | ||
| - Developer Edition: cloud/getting_started/de_getting_started.md | ||
| #- Developer Edition: cloud/getting_started/de_getting_started.md |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if the Developer Edition doc file still exists
if [ -f "docs/cloud/getting_started/de_getting_started.md" ]; then
echo "File exists - consider deleting or adding a note about why it's retained"
head -20 "docs/cloud/getting_started/de_getting_started.md"
else
echo "File does not exist - navigation removal is clean"
fiRepository: pgEdge/pgedge-docs
Length of output: 1371
Address orphaned Developer Edition documentation.
The commented-out navigation entry leaves the referenced file docs/cloud/getting_started/de_getting_started.md orphaned—it will no longer be discoverable through site navigation. Since the file contains full product documentation, either delete it if Developer Edition is being fully removed, or restore the navigation entry if the product remains supported.
🤖 Prompt for AI Agents
In `@mkdocs.yml` at line 334, The commented navigation line referencing
de_getting_started.md leaves that document orphaned; either remove the unused
file docs/cloud/getting_started/de_getting_started.md if Developer Edition is
removed, or restore the navigation by uncommenting the line "- Developer
Edition: cloud/getting_started/de_getting_started.md" in mkdocs.yml (ensuring
the path matches the file name de_getting_started.md) so the page is
discoverable; choose and apply one of these actions and update mkdocs.yml
accordingly.
…d removing designer addition
There was a problem hiding this comment.
Documentation Review
I've reviewed the documentation changes in this PR against the pgEdge stylesheet requirements. Overall, the changes improve readability by wrapping lines to 79 characters and updating content to reflect the removal of Developer Edition. Here are my findings:
✅ Strengths
- Line wrapping: All changes properly wrap lines to 79 characters while keeping inline markdown links on the same line, as required by the stylesheet.
- Active voice: The documentation maintains active voice throughout.
- Articles: Proper use of articles (a, an, the) is maintained.
- Image alt text: Screenshots have been updated with appropriate descriptions.
- Security: No security issues found in the documented examples.
⚠️ Issues Found
1. Bulleted list formatting issues (docs/cloud/index.md)
The stylesheet (lines 19-24) requires:
- Always leave a blank line before the first item in any list
- Each entry should be a complete sentence with articles
- Do not use bold font bullet items
Problem: In docs/cloud/index.md, the feature list items are not complete sentences and lack proper formatting:
Multi-Region and Multi-Cloud: Deploy nodes across multiple cloud provider
regions to provide optimal placement relative to your users.Should be reformatted as a bulleted list with complete sentences, like:
The pgEdge Cloud includes the following features:
* Multi-Region and Multi-Cloud support allows you to deploy nodes across multiple cloud provider regions.
* Easy Deployment simplifies the creation process with a guided interface.2. Missing section heading (docs/cloud/manage_cluster.md)
Problem: Line 119 in the diff shows a table row header being split incorrectly:
| Network Receive | The amount of data received by the
| | instance |This creates an incomplete table row. The original single-line format was correct for tables.
3. Inconsistent heading structure (docs/cloud/index.md)
The removed table "pgEdge Cloud Features by Edition" leaves the document without a clear features section. Consider adding a proper heading if features need to be documented differently.
📝 Minor Observations
- The removal of Developer Edition references is consistent across all files.
- The updated screenshots align with the textual changes.
- The mkdocs.yml navigation simplification is appropriate.
Recommendation
Request changes for the bulleted list formatting in docs/cloud/index.md and the table formatting issue in docs/cloud/manage_cluster.md to ensure compliance with the stylesheet before merging.
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/cloud/getting_started/ee_getting_started.md (1)
1-13: Fix GitHub capitalization in the signup sentence.✏️ Suggested edit
-or log in with your Google or Github account. +or log in with your Google or GitHub account.
🤖 Fix all issues with AI agents
In `@docs/cloud/cluster/create_cluster.md`:
- Around line 97-102: In the paragraph describing VPC association, capitalize
the acronym "DNS" for consistency by replacing "dns failover" with "DNS
failover" in docs/cloud/cluster/create_cluster.md (look for the sentence
mentioning "latency routing and dns failover"); ensure any other occurrences of
the lowercase "dns" in that section are similarly updated to "DNS".
- Around line 83-92: The example resource tag "team/ db-ops" contains an extra
space after the slash; update the text so the tag reads "team/db-ops" (no space)
wherever it appears in the "Add Resource Tag" explanation and ensure the
description that mentions `Key` and `Value` still states that terms are
displayed with a `/` delimiter (e.g., "team/db-ops") to maintain consistent
formatting.
In `@docs/cloud/cluster/manage_cluster.md`:
- Around line 99-104: Replace the ungrammatical sentence "Use the drop-down at
the top of the `Metrics` pane allows you to specify the length of time displayed
by each graph." with a corrected form; either change to an imperative ("Use the
drop-down at the top of the `Metrics` pane to specify the length of time
displayed by each graph.") or a descriptive subject-verb form ("The drop-down at
the top of the `Metrics` pane allows you to specify the length of time displayed
by each graph."), updating the sentence near the text fragment `Use the
drop-down at the top of the `Metrics` pane allows you` in the document.
- Around line 115-118: The table rows for "Network Receive" and "Network Send"
are broken across lines and missing vertical pipes; fix them by combining each
row into a single line with proper pipe separators so each cell is complete
(e.g., a row starting with "| Network Receive | The amount of data received by
the instance |" and similarly for "Network Send"), ensuring the table pipe
alignment matches the surrounding rows and renders correctly.
♻️ Duplicate comments (1)
docs/cloud/cluster/create_cluster.md (1)
108-135: Fix nested bullet indentation in Firewall Rules.
This matches a prior review comment; keeping it in view because the lint issue still applies.✏️ Suggested edit
- * Select `PostgreSQL` to create a connection to port `5432`; this is - the port used by connecting clients that wish to query the database. + * Select `PostgreSQL` to create a connection to port `5432`; this is + the port used by connecting clients that wish to query the database. - * Select `HTTPS` to open port `443` for secure communication between - PostgreSQL and a web server. + * Select `HTTPS` to open port `443` for secure communication between + PostgreSQL and a web server. - * Select `SSH` to open port `22` for SSH connections. + * Select `SSH` to open port `22` for SSH connections. - * Choose `My IP:x.x.x.x` to open a port for the detected IP address - from which you are connected. - * Choose `All IPV4` to allow connections to the selected port from any - source. This setting is not recommended for connections to the - database server. + * Choose `My IP:x.x.x.x` to open a port for the detected IP address + from which you are connected. + * Choose `All IPV4` to allow connections to the selected port from any + source. This setting is not recommended for connections to the + database server.
| A [resource tag](resource_tag.md) is a user-defined key/value information | ||
| pair that you attach to your cluster definition. The tag is displayed under | ||
| the cluster name on the `Clusters` page. You can use tags to categorize your | ||
| cloud resources or search for resources that are used for specific teams or | ||
| applications. For example, you may want to include a tag that specifies | ||
| `team/ db-ops` to make it easy to identify the resources that are used by the | ||
| `db-ops` team. | ||
|
|
||
| A [resource tag](resource_tag.md) is a user-defined key/value information pair that you attach to your cluster definition. The tag is displayed under the cluster name on the `Clusters` page. You can use tags to categorize your cloud resources or search for resources that are used for specific teams or applications. For example, you may want to include a tag that specifies `team/ db-ops` to make it easy to identify the resources that are used by the `db-ops` team. | ||
| To add a resource tag, select `Add Resource Tag`, and then specify the `Key` | ||
| and `Value`; the terms will be displayed with a `/` used as a delimiter. |
There was a problem hiding this comment.
Fix the resource tag example formatting.
There’s an extra space after the slash.
✏️ Suggested edit
-`team/ db-ops`
+`team/db-ops`📝 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.
| A [resource tag](resource_tag.md) is a user-defined key/value information | |
| pair that you attach to your cluster definition. The tag is displayed under | |
| the cluster name on the `Clusters` page. You can use tags to categorize your | |
| cloud resources or search for resources that are used for specific teams or | |
| applications. For example, you may want to include a tag that specifies | |
| `team/ db-ops` to make it easy to identify the resources that are used by the | |
| `db-ops` team. | |
| A [resource tag](resource_tag.md) is a user-defined key/value information pair that you attach to your cluster definition. The tag is displayed under the cluster name on the `Clusters` page. You can use tags to categorize your cloud resources or search for resources that are used for specific teams or applications. For example, you may want to include a tag that specifies `team/ db-ops` to make it easy to identify the resources that are used by the `db-ops` team. | |
| To add a resource tag, select `Add Resource Tag`, and then specify the `Key` | |
| and `Value`; the terms will be displayed with a `/` used as a delimiter. | |
| A [resource tag](resource_tag.md) is a user-defined key/value information | |
| pair that you attach to your cluster definition. The tag is displayed under | |
| the cluster name on the `Clusters` page. You can use tags to categorize your | |
| cloud resources or search for resources that are used for specific teams or | |
| applications. For example, you may want to include a tag that specifies | |
| `team/db-ops` to make it easy to identify the resources that are used by the | |
| `db-ops` team. | |
| To add a resource tag, select `Add Resource Tag`, and then specify the `Key` | |
| and `Value`; the terms will be displayed with a `/` used as a delimiter. |
🤖 Prompt for AI Agents
In `@docs/cloud/cluster/create_cluster.md` around lines 83 - 92, The example
resource tag "team/ db-ops" contains an extra space after the slash; update the
text so the tag reads "team/db-ops" (no space) wherever it appears in the "Add
Resource Tag" explanation and ensure the description that mentions `Key` and
`Value` still states that terms are displayed with a `/` delimiter (e.g.,
"team/db-ops") to maintain consistent formatting.
| You can define a [VPC association](vpc_assoc.md) to configure VPC peering | ||
| and (if needed) private zone routing between any defined VPCs and the pgEdge | ||
| cluster network. Peering allows an application to connect seamlessly to any | ||
| of the nodes across regions, allowing you to fully leverage latency routing | ||
| and dns failover. This is currently only available for AWS. | ||
|
|
There was a problem hiding this comment.
Capitalize DNS for consistency.
✏️ Suggested edit
-and dns failover. This is currently only available for AWS.
+and DNS failover. This is currently only available for AWS.🤖 Prompt for AI Agents
In `@docs/cloud/cluster/create_cluster.md` around lines 97 - 102, In the paragraph
describing VPC association, capitalize the acronym "DNS" for consistency by
replacing "dns failover" with "DNS failover" in
docs/cloud/cluster/create_cluster.md (look for the sentence mentioning "latency
routing and dns failover"); ensure any other occurrences of the lowercase "dns"
in that section are similarly updated to "DNS".
| Use the drop-down at the top of the `Metrics` pane allows you to | ||
| specify the length of time displayed by each graph. | ||
|
|
||
| Select a point on a graph to display information about the graphed event that occurred on your cluster: | ||
| Select a point on a graph to display information about the graphed event | ||
| that occurred on your cluster: | ||
|
|
There was a problem hiding this comment.
Fix the drop‑down sentence grammar.
“Use the drop‑down … allows you” is ungrammatical.
✏️ Suggested edit
-Use the drop-down at the top of the `Metrics` pane allows you to
-specify the length of time displayed by each graph.
+Use the drop-down at the top of the `Metrics` pane to specify the length
+of time displayed by each graph.📝 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.
| Use the drop-down at the top of the `Metrics` pane allows you to | |
| specify the length of time displayed by each graph. | |
| Select a point on a graph to display information about the graphed event that occurred on your cluster: | |
| Select a point on a graph to display information about the graphed event | |
| that occurred on your cluster: | |
| Use the drop-down at the top of the `Metrics` pane to specify the length | |
| of time displayed by each graph. | |
| Select a point on a graph to display information about the graphed event | |
| that occurred on your cluster: |
🤖 Prompt for AI Agents
In `@docs/cloud/cluster/manage_cluster.md` around lines 99 - 104, Replace the
ungrammatical sentence "Use the drop-down at the top of the `Metrics` pane
allows you to specify the length of time displayed by each graph." with a
corrected form; either change to an imperative ("Use the drop-down at the top of
the `Metrics` pane to specify the length of time displayed by each graph.") or a
descriptive subject-verb form ("The drop-down at the top of the `Metrics` pane
allows you to specify the length of time displayed by each graph."), updating
the sentence near the text fragment `Use the drop-down at the top of the
`Metrics` pane allows you` in the document.
There was a problem hiding this comment.
Documentation Review for PR #32
I've reviewed the documentation changes in this PR against the pgEdge stylesheet (/pgedge_stylesheet.md). Overall, the changes improve readability and update content to reflect the current product offering. Here are my findings:
✅ Positive Changes
-
Line wrapping improvements: The changes correctly wrap lines to 79 characters, which aligns with the stylesheet requirement.
-
Content updates: Removing references to "Enterprise Edition" vs "Developer Edition" distinctions simplifies the documentation and removes the edition comparison table that was likely outdated.
-
Image alt text consistency: Screenshot updates appear to maintain consistent naming conventions.
-
Improved readability: Text reflows generally improve sentence structure and make instructions clearer.
⚠️ Issues Found
1. Markdown Table Formatting Issue (docs/cloud/cluster/manage_cluster.md)
The metrics table has been incorrectly reformatted. Lines 115-117 show:
| Network Receive | The amount of data received by the
| | instance |
| Network Send | The amount of data transmitted from the
| | instance |This breaks the table structure. The description should remain on a single line per the stylesheet: "keep standard inline markdown links all be on the same line" and table cells should not be split across rows.
Recommended fix:
| Network Receive | The amount of data received by the instance |
| Network Send | The amount of data transmitted from the instance |2. Missing Section Heading (docs/cloud/cluster/manage_cluster.md)
Line 119 shows the "Reviewing Cluster Log Files" section heading was removed, but the log files content remains. Per the stylesheet: "Each file should have one first level heading, and multiple second level headings." This section should have its heading restored.
Recommended fix: Add back ### Reviewing Cluster Log Files before line 119.
3. Sentence Length Concerns
Several bullet points exceed the stylesheet's 7-20 word guideline and could benefit from semicolons or sentence breaks. Examples:
- docs/cloud/cluster/create_cluster.md:88-91: "You can use tags to categorize your cloud resources or search for resources that are used for specific teams or applications." (19 words - borderline)
- docs/cloud/database/create_db.md:36-38: "The default configuration defines a schedule that includes a daily full backup, with hourly incremental backups." (16 words - acceptable but could be clearer)
These are minor and within acceptable range.
🔍 No Security Issues Found
No SQL injection, authentication bypasses, or input validation issues detected in the documentation examples.
📝 Recommendations
- High Priority: Fix the broken metrics table in
manage_cluster.md - High Priority: Restore the "Reviewing Cluster Log Files" section heading
- Low Priority: Consider whether some longer sentences could be split for better readability
The documentation changes are generally well-executed and improve the user experience. The main issues are formatting problems that should be addressed before merge.
There was a problem hiding this comment.
Documentation Review
I've reviewed this PR against the pgEdge stylesheet requirements. Overall, the documentation changes improve readability by reflowing text to meet the 79-character line wrap requirement. However, there are several areas that need attention:
Line Wrapping Issues
The stylesheet requires wrapping lines to 79 characters, but inline markdown links should remain on the same line. Several locations violate this:
docs/cloud/cluster/create_cluster.md:
- Lines 16-18: The link breaks across lines improperly
- Lines 66-67: Link should stay on one line with the sentence
docs/cloud/database/create_db.md:
- Lines 17-18: Link to "PostgreSQL Version" documentation breaks improperly
docs/cloud/database/manage_db.md:
- Lines 36-38: Links break improperly across lines
Missing Articles
Per the stylesheet: "Use articles (a, an, and the) when appropriate."
docs/cloud/index.md (lines 8-39):
The "Fully distributed PostgreSQL Made Easy" section reformats feature descriptions but removes bold formatting and uses colons instead of proper headers. This is problematic because:
- Lines 8, 12, 16, 19, 25, 31, 34, 37 now start with labels followed by colons
- These should either be proper third-level headings (
###) or remain as bold items in a list - The stylesheet says "Do not use bold font bullet items" but these aren't bullets anymore
The current format reads like labels rather than prose. Consider either:
- Converting to third-level headings with introductory sentences
- Keeping as bulleted list with full sentences (without bold)
docs/cloud/database/create_db.md (line 20):
- "Select the cluster you would like to host" - missing article "a" before "cluster"
Sentence Structure Issues
docs/cloud/cluster/create_cluster.md:
- Line 88: "you may want to include a tag that specifies
team/ db-ops" - extra space after/should beteam/db-ops
docs/cloud/database/manage_db.md:
- Line 30: "Enterprise Edition" reference - the PR removes edition distinctions elsewhere but keeps it here
Inconsistent Formatting
docs/cloud/getting_started/ee_getting_started.md:
- Line 3: Very long sentence (79+ characters) that wraps improperly with an inline link
Images Alt Text
While many image alt texts look good, verify all screenshots match the updated UI as mentioned in the PR description.
Positive Notes
The following aspects align well with the stylesheet:
- Active voice usage throughout
- Proper use of code formatting with backticks
- Bulleted lists have blank lines before the first item
- Complete sentences with appropriate punctuation
- Good explanatory sentences before code/UI descriptions
Security & Code Issues
No security issues identified - this is pure documentation with no code examples that could introduce vulnerabilities.
Recommendation
The changes improve overall readability and modernize the content. Please address the line wrapping issues with inline links and consider restructuring the feature list in index.md for better consistency with the stylesheet.
There was a problem hiding this comment.
Documentation Review
I've reviewed the changes in this PR against the pgEdge stylesheet (pgedge_stylesheet.md). The changes overall improve readability through better line wrapping and updated screenshots. However, there are several stylesheet violations that need to be addressed:
Critical Issues
1. Missing Features/Overview List Format (docs/cloud/index.md)
Lines 8-39 violate the stylesheet. According to the stylesheet (lines 19-24):
If the page has a
FeaturesorOverviewsection following the introductory paragraph, it should not start with a heading; instead use a sentence in the form: "The MCP Server includes the following features:", followed by a bulleted list of the features.
Currently, the section uses a heading "## Fully distributed PostgreSQL Made Easy" followed by paragraphs that start with bold labels like "Multi-Region and Multi-Cloud:".
Fix: Replace the heading with a sentence like "pgEdge Cloud includes the following features:" and format as a proper bulleted list. Each bullet should be a complete sentence with articles (not bold labels).
2. Missing Blank Line Before Lists
Multiple violations across files (stylesheet line 21 states: "Always leave a blank line before the first item in any list or sub-list"):
docs/cloud/index.mdlines 46-48: Missing blank line before the bullet listdocs/cloud/database/create_db.mdline 10: Missing blank line before the bulleted list
3. Missing Newline at End of File
docs/cloud/database/manage_db.md is missing a trailing newline (line 192). The file ends without a newline character, which violates standard Unix text file conventions.
Style Issues
4. Image Alt Text Could Be More Descriptive
Several image alt texts are generic. While this isn't strictly a stylesheet violation, alt text like "Creating a Database" (used twice in create_db.md) could be more specific about what each screenshot shows.
5. Inconsistent Spacing
docs/cloud/cluster/resource_tag.mdline 11: "team/db-ops" has inconsistent spacing compared to line 88 of create_cluster.md which uses "team/ db-ops" (with a space after the slash)
Security Considerations
No security issues found. The documentation doesn't include any code examples with SQL injection vulnerabilities, authentication bypasses, or input validation problems.
Positive Changes
- Line wrapping to 79 characters is properly implemented throughout
- Active voice is used appropriately
- Sentences are grammatically correct and fall within 7-20 word range
- Articles (a, an, the) are properly used
- Links remain on single lines as required
Recommendation
Please address the critical issues, particularly:
- Reformatting the features section in
docs/cloud/index.mdto match stylesheet requirements - Adding missing blank lines before lists
- Adding the trailing newline to
docs/cloud/database/manage_db.md
The consistency issues (spacing in tags) should also be corrected to maintain uniformity across the documentation.
There was a problem hiding this comment.
Documentation Review: PR #32
I've completed a comprehensive review of this PR against the project's stylesheet requirements. Overall, this is a well-executed documentation refresh with good adherence to standards, but there are some stylesheet violations that should be addressed.
✅ Security Review
No security issues found. All code examples properly handle credentials, maintain security best practices, and do not expose sensitive information.
✅ Positive Findings
The PR demonstrates excellent adherence to many stylesheet requirements:
- Line wrapping: Most content properly wraps to 79 characters while keeping inline markdown links intact
- Code formatting: Consistent use of backticks for inline code and proper code blocks with language tags
- List formatting: Blank lines before lists are consistently implemented
- Capitalization: SQL keywords properly capitalized, variables lowercase
- Structure: Proper heading hierarchy with one first-level heading per file
⚠️ Stylesheet Violations Found
Critical Issues
-
Incomplete sentences in bulleted list (
docs/cloud/connecting/custom_client.md)+* ([TypeScript](#connecting-with-typescript) +* [Python](#connecting-with-python) +* [Go](#connecting-with-go))
Per stylesheet: "Each entry in a bulleted list should be a complete sentence with articles." These are fragments with improper parentheses. Should be complete sentences.
-
Sentences exceeding 20-word limit (stylesheet requires 7-20 words):
docs/cloud/backup/backup_providers.md: 31-word sentence starting with "When you create a database using pgBackRest..."docs/cloud/mod_cluster/add.md: 33-word sentence starting with "The cluster will be placed in modification status..."
Major Issues
-
Passive voice usage (stylesheet requires active voice):
docs/cloud/backup/backup_providers.md: "A default backup configuration is provided..." (should be "The system provides...")docs/cloud/index.md: "Your data is subject to regularly scheduled backups and continually monitored." (should be "The system regularly backs up and continually monitors your data.")
-
Double spacing after periods (
docs/cloud/database/create_db.md):+ navigation tree control. If you have more than one databaseShould use single space after period.
Minor Issues
- Missing article (
docs/cloud/getting_started/ee_getting_started.md):Should be "Signing up for the pgEdge Postgres Cloud edition is easy"+Signing up for pgEdge Postgres Cloud edition is easy
📋 Recommendations
- Rewrite the bulleted list in
custom_client.mdas complete sentences - Split long sentences (>20 words) into two sentences
- Convert passive voice constructions to active voice
- Fix double spacing in
create_db.md - Add missing article in
ee_getting_started.md
📊 Overall Assessment
This PR represents a solid documentation update with clear strategic direction (removing Developer Edition references and simplifying content). The changes are low-risk and user-facing improvements. With the stylesheet violations corrected, this will be a strong contribution to the documentation.
Recommendation: Request changes to address the critical and major stylesheet violations before merge.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/cloud/mod_cluster/add.md`:
- Line 54: Replace the non-descriptive link text "here" with a meaningful phrase
that conveys the destination (e.g., "restoring data workflows" or "recommended
restoration workflows") for the link pointing to the anchor
"#restoring-data-to-a-database-on-a-new-cluster-node"; update the markdown at
the occurrence of the link so the display text is descriptive while keeping the
same URL/anchor to preserve navigation and accessibility.
- Line 44: Fix the grammar by inserting the indefinite article "a" before the
phrase "new cluster node": change the text "that new cluster node must be" to
"that a new cluster node must be" so the sentence reads correctly.
🧹 Nitpick comments (2)
docs/cloud/connecting/custom_client.md (1)
3-7: Fix the malformed bullet list.The parentheses around the list items are unbalanced (
* (at Line 5 and))at Line 7), which breaks Markdown rendering. Consider a normal list without parentheses.📌 Proposed fix
-The `Code Snippets` pane displays three code snippets: - -* ([TypeScript](`#connecting-with-typescript`) -* [Python](`#connecting-with-python`) -* [Go](`#connecting-with-go`)) +The `Code Snippets` pane displays three code snippets: + +* [TypeScript](`#connecting-with-typescript`) +* [Python](`#connecting-with-python`) +* [Go](`#connecting-with-go`)docs/cloud/connecting/psql.md (1)
29-33: Consider varying repeated sentence starts for readability.Three consecutive bullets begin with “When prompted…”. Minor readability improvement if you vary the phrasing.
| To add a database to a cluster node, select the database name in the navigation panel, open the `Actions` menu, and select `Add to Nodes`. Note that new cluster node must be [added to the cluster](#adding-a-node-to-a-cluster) before you can add a database to the node. The node to which you are adding the database must be a member of the cluster on which the database was created. | ||
| To add a database to a cluster node, select the database name in the | ||
| navigation panel, open the `Actions` menu, and select `Add to Nodes`. Note | ||
| that new cluster node must be |
There was a problem hiding this comment.
Add missing article for grammatical correctness.
The phrase "new cluster node" requires the indefinite article "a" before it.
📝 Proposed fix
-that new cluster node must be
+that a new cluster node must be 📝 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.
| that new cluster node must be | |
| that a new cluster node must be |
🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` at line 44, Fix the grammar by inserting the
indefinite article "a" before the phrase "new cluster node": change the text
"that new cluster node must be" to "that a new cluster node must be" so the
sentence reads correctly.
| is not enabled, start replication on the node. Once replication has been | ||
| re-established, new transactions can be written to the database. To review | ||
| recommended workflows to bring the node up to date with a full dataset | ||
| visit [here](#restoring-data-to-a-database-on-a-new-cluster-node). |
There was a problem hiding this comment.
Use descriptive link text for accessibility.
The link text "here" is not descriptive. Consider using text that indicates the destination, such as "restoring data workflows" or "recommended restoration workflows."
♿ Proposed fix for better accessibility
-visit [here](`#restoring-data-to-a-database-on-a-new-cluster-node`).
+visit [restoring data workflows](`#restoring-data-to-a-database-on-a-new-cluster-node`).Based on static analysis hints, non-descriptive link text reduces accessibility for screen reader users.
📝 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.
| visit [here](#restoring-data-to-a-database-on-a-new-cluster-node). | |
| visit [restoring data workflows](`#restoring-data-to-a-database-on-a-new-cluster-node`). |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
54-54: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` at line 54, Replace the non-descriptive link
text "here" with a meaningful phrase that conveys the destination (e.g.,
"restoring data workflows" or "recommended restoration workflows") for the link
pointing to the anchor "#restoring-data-to-a-database-on-a-new-cluster-node";
update the markdown at the occurrence of the link so the display text is
descriptive while keeping the same URL/anchor to preserve navigation and
accessibility.
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Fix all issues with AI agents
In `@docs/cloud/backup/backup_providers.md`:
- Around line 62-67: The nested list under "Select a `Backup Type` for the new
schedule" uses 4-space indentation; change each nested bullet ("Full",
"Incremental", "Differential") to use 2-space indentation so they align with the
parent list and Markdown best practices—ensure the bullets remain prefixed with
'*' and preserve the text and code formatting for `Backup Type`, `Full`,
`Incremental`, and `Differential`.
- Around line 118-124: The nested bullet list under the "Backup Type" field uses
4-space indentation causing inconsistent formatting; update the indentation for
the nested list items (`Full`, `Incremental`, `Differential`) to use 2 spaces
instead of 4 so they align with the document's recommended 2-space nesting style
and render correctly in Markdown; ensure the inner lines (like the continued
sentence for `Incremental` and the `Full` reference in `Differential`) are also
adjusted to the same 2-space indentation.
In `@docs/cloud/mod_cluster/add.md`:
- Around line 94-95: Replace the word "if" with "whether" in the sentence "will
depend on if your nodes are running with AutoDDL enabled." so it reads "will
depend on whether your nodes are running with AutoDDL enabled." — update the
sentence in docs/cloud/mod_cluster/add.md near the line containing "AutoDDL" to
improve clarity.
- Line 31: Change the past-tense phrase "when the update finished" to
present-tense "when the update finishes" in the sentence containing "addition is
complete; when the update finished, you will be able to access" so the sentence
reads "addition is complete; when the update finishes, you will be able to
access".
- Around line 87-89: Fix the grammatical tense in the sentence that currently
reads "We recommended that you stop write transactions..." by changing "We
recommended" to "We recommend"; also tighten the following sentence for clarity
by replacing "If write transactions are enabled, it is possible for data to not
reach other nodes" with a clearer phrasing such as "If write transactions are
enabled, data might not propagate to other nodes." Locate and update the two
sentences in the restore/cluster guidance section (the sentence starting with
"We recommended..." and the following sentence about write transactions).
- Line 17: The sentence currently reads "When the `Add Node` dialog opens,
provide details the new node(s):" — add the missing preposition "for" so it
reads "When the `Add Node` dialog opens, provide details for the new node(s):"
(look for the exact phrase "provide details the new node(s)" in the docs and
update it to include "for").
- Around line 44-46: The sentence fragment "that new cluster node must be" is
missing the indefinite article; update the text so it reads "that a new cluster
node must be" (i.e., insert "a" before "new cluster node") in the paragraph
containing the phrase "that new cluster node must be [added to the
cluster](`#adding-a-node-to-a-cluster`) before you can add a database to the
node."
🧹 Nitpick comments (1)
docs/cloud/connecting/psql.md (1)
32-35: Inconsistent capitalization of "Return".Line 32 uses "press
Return" while line 35 uses "Pressreturn". Consider standardizing the capitalization for consistency.📝 Suggested standardization
-Press `return` to connect to your database: +Press `Return` to connect to your database:
| * Select a `Backup Type` for the new schedule; choose: | ||
| * `Full` to schedule a complete backup of the specified nodes. | ||
| * `Incremental` to backup modifications to the database since the last backup of any type (whether full, differential, or incremental). | ||
| * `Differential` to backup changes to the database since the last full backup. | ||
| * `Incremental` to backup modifications to the database since the last | ||
| backup of any type (whether full, differential, or incremental). | ||
| * `Differential` to backup changes to the database since the last | ||
| full backup. |
There was a problem hiding this comment.
Fix nested list indentation.
The nested list items use 4-space indentation but should use 2-space indentation for consistency with Markdown best practices.
📝 Proposed fix for list indentation
* Select a `Backup Type` for the new schedule; choose:
- * `Full` to schedule a complete backup of the specified nodes.
- * `Incremental` to backup modifications to the database since the last
- backup of any type (whether full, differential, or incremental).
- * `Differential` to backup changes to the database since the last
- full backup.
+ * `Full` to schedule a complete backup of the specified nodes.
+ * `Incremental` to backup modifications to the database since the last
+ backup of any type (whether full, differential, or incremental).
+ * `Differential` to backup changes to the database since the last
+ full backup.📝 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.
| * Select a `Backup Type` for the new schedule; choose: | |
| * `Full` to schedule a complete backup of the specified nodes. | |
| * `Incremental` to backup modifications to the database since the last backup of any type (whether full, differential, or incremental). | |
| * `Differential` to backup changes to the database since the last full backup. | |
| * `Incremental` to backup modifications to the database since the last | |
| backup of any type (whether full, differential, or incremental). | |
| * `Differential` to backup changes to the database since the last | |
| full backup. | |
| * Select a `Backup Type` for the new schedule; choose: | |
| * `Full` to schedule a complete backup of the specified nodes. | |
| * `Incremental` to backup modifications to the database since the last | |
| backup of any type (whether full, differential, or incremental). | |
| * `Differential` to backup changes to the database since the last | |
| full backup. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
63-63: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
64-64: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In `@docs/cloud/backup/backup_providers.md` around lines 62 - 67, The nested list
under "Select a `Backup Type` for the new schedule" uses 4-space indentation;
change each nested bullet ("Full", "Incremental", "Differential") to use 2-space
indentation so they align with the parent list and Markdown best
practices—ensure the bullets remain prefixed with '*' and preserve the text and
code formatting for `Backup Type`, `Full`, `Incremental`, and `Differential`.
| * Specify the type of backup in the `Backup Type` field. Choose: | ||
|
|
||
| * `Full` to do a complete backup of the selected database and nodes. | ||
| * `Incremental` to backup only those items that have changed since the last backup. | ||
| * `Differential` to backup any items that have changed since the last *Full* backup. | ||
| * `Incremental` to backup only those items that have changed since the | ||
| last backup. | ||
| * `Differential` to backup any items that have changed since the last | ||
| *Full* backup. |
There was a problem hiding this comment.
Fix nested list indentation.
Similar to the earlier section, these nested list items use 4-space indentation instead of the recommended 2-space indentation.
📝 Proposed fix for list indentation
* Specify the type of backup in the `Backup Type` field. Choose:
- * `Full` to do a complete backup of the selected database and nodes.
- * `Incremental` to backup only those items that have changed since the
- last backup.
- * `Differential` to backup any items that have changed since the last
- *Full* backup.
+ * `Full` to do a complete backup of the selected database and nodes.
+ * `Incremental` to backup only those items that have changed since the
+ last backup.
+ * `Differential` to backup any items that have changed since the last
+ *Full* backup.📝 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.
| * Specify the type of backup in the `Backup Type` field. Choose: | |
| * `Full` to do a complete backup of the selected database and nodes. | |
| * `Incremental` to backup only those items that have changed since the last backup. | |
| * `Differential` to backup any items that have changed since the last *Full* backup. | |
| * `Incremental` to backup only those items that have changed since the | |
| last backup. | |
| * `Differential` to backup any items that have changed since the last | |
| *Full* backup. | |
| * Specify the type of backup in the `Backup Type` field. Choose: | |
| * `Full` to do a complete backup of the selected database and nodes. | |
| * `Incremental` to backup only those items that have changed since the | |
| last backup. | |
| * `Differential` to backup any items that have changed since the last | |
| *Full* backup. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
120-120: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
123-123: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In `@docs/cloud/backup/backup_providers.md` around lines 118 - 124, The nested
bullet list under the "Backup Type" field uses 4-space indentation causing
inconsistent formatting; update the indentation for the nested list items
(`Full`, `Incremental`, `Differential`) to use 2 spaces instead of 4 so they
align with the document's recommended 2-space nesting style and render correctly
in Markdown; ensure the inner lines (like the continued sentence for
`Incremental` and the `Full` reference in `Differential`) are also adjusted to
the same 2-space indentation.
|  | ||
|
|
||
| When the `Add Node` dialog opens as shown below, provide details the new node(s): | ||
| When the `Add Node` dialog opens, provide details the new node(s): |
There was a problem hiding this comment.
Fix missing preposition (“details for the new node(s)”).
Current text reads “provide details the new node(s)”.
✅ Suggested edit
-When the `Add Node` dialog opens, provide details the new node(s):
+When the `Add Node` dialog opens, provide details for the new node(s):📝 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.
| When the `Add Node` dialog opens, provide details the new node(s): | |
| When the `Add Node` dialog opens, provide details for the new node(s): |
🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` at line 17, The sentence currently reads "When
the `Add Node` dialog opens, provide details the new node(s):" — add the missing
preposition "for" so it reads "When the `Add Node` dialog opens, provide details
for the new node(s):" (look for the exact phrase "provide details the new
node(s)" in the docs and update it to include "for").
| Select the `Add Nodes` button to deploy your new nodes and add them to your cluster. The cluster will be placed in modification status until the addition is complete; when the update finished, you will be able to access the new node using the SSH configuration defined during the initial cluster creation. | ||
| Select the `Add Nodes` button to deploy your new nodes and add them to | ||
| your cluster. The cluster will be placed in modification status until the | ||
| addition is complete; when the update finished, you will be able to access |
There was a problem hiding this comment.
Tense agreement: “when the update finishes.”
✅ Suggested edit
- addition is complete; when the update finished, you will be able to access
+ addition is complete; when the update finishes, you will be able to access📝 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.
| addition is complete; when the update finished, you will be able to access | |
| addition is complete; when the update finishes, you will be able to access |
🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` at line 31, Change the past-tense phrase "when
the update finished" to present-tense "when the update finishes" in the sentence
containing "addition is complete; when the update finished, you will be able to
access" so the sentence reads "addition is complete; when the update finishes,
you will be able to access".
| that new cluster node must be | ||
| [added to the cluster](#adding-a-node-to-a-cluster) before you can add a | ||
| database to the node. The node to which you are adding the database must |
There was a problem hiding this comment.
Add missing article: “a new cluster node”.
✅ Suggested edit
-Note that new cluster node must be
+Note that a new cluster node must be🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` around lines 44 - 46, The sentence fragment
"that new cluster node must be" is missing the indefinite article; update the
text so it reads "that a new cluster node must be" (i.e., insert "a" before "new
cluster node") in the paragraph containing the phrase "that new cluster node
must be [added to the cluster](`#adding-a-node-to-a-cluster`) before you can add a
database to the node."
| We recommended that you stop write transactions to the database while you | ||
| are restoring data to align the nodes across the cluster. If write | ||
| transactions are enabled, it is possible for data to not reach other nodes |
There was a problem hiding this comment.
Grammar: “We recommend…”
✅ Suggested edit
-We recommended that you stop write transactions to the database while you
+We recommend that you stop write transactions to the database while you📝 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.
| We recommended that you stop write transactions to the database while you | |
| are restoring data to align the nodes across the cluster. If write | |
| transactions are enabled, it is possible for data to not reach other nodes | |
| We recommend that you stop write transactions to the database while you | |
| are restoring data to align the nodes across the cluster. If write | |
| transactions are enabled, it is possible for data to not reach other nodes |
🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` around lines 87 - 89, Fix the grammatical
tense in the sentence that currently reads "We recommended that you stop write
transactions..." by changing "We recommended" to "We recommend"; also tighten
the following sentence for clarity by replacing "If write transactions are
enabled, it is possible for data to not reach other nodes" with a clearer
phrasing such as "If write transactions are enabled, data might not propagate to
other nodes." Locate and update the two sentences in the restore/cluster
guidance section (the sentence starting with "We recommended..." and the
following sentence about write transactions).
| will depend on if your nodes are running with AutoDDL enabled. | ||
|
|
There was a problem hiding this comment.
Use “whether” instead of “if” for clarity.
✅ Suggested edit
-will depend on if your nodes are running with AutoDDL enabled.
+will depend on whether your nodes are running with AutoDDL enabled.📝 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.
| will depend on if your nodes are running with AutoDDL enabled. | |
| will depend on whether your nodes are running with AutoDDL enabled. |
🤖 Prompt for AI Agents
In `@docs/cloud/mod_cluster/add.md` around lines 94 - 95, Replace the word "if"
with "whether" in the sentence "will depend on if your nodes are running with
AutoDDL enabled." so it reads "will depend on whether your nodes are running
with AutoDDL enabled." — update the sentence in docs/cloud/mod_cluster/add.md
near the line containing "AutoDDL" to improve clarity.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/cloud/cluster/backup_store.md`:
- Around line 68-71: Replace the incorrect plural phrase "clusters backup
stores" with the possessive "cluster's backup stores" in the sentence inside the
Backup Stores dialog instructions; update the line that reads "When you've
identified the clusters backup stores, select the `Update Backup Stores` button
to update the cluster." to use the possessive form so it becomes "When you've
identified the cluster's backup stores, select the `Update Backup Stores` button
to update the cluster."
♻️ Duplicate comments (3)
docs/cloud/cluster/create_cluster.md (3)
81-87: Fix the resource tag example formatting.
The example contains an extra space after the slash; keep it consistent with the delimiter description.✏️ Suggested edit
-`team/ db-ops` +`team/db-ops`
95-100: Capitalize DNS for consistency.✏️ Suggested edit
-and dns failover. This is currently only available for AWS. +and DNS failover. This is currently only available for AWS.
112-129: Fix nested bullet indentation in Firewall Rules.
The sub-bullets are indented with 4 spaces; markdownlint expects 2.📝 Proposed fix for indentation
* Use the `Type` drop-down to select the connection type you are defining: - * Select `PostgreSQL` to create a connection to port `5432`; this is - the port used by connecting clients that wish to query the database. + * Select `PostgreSQL` to create a connection to port `5432`; this is + the port used by connecting clients that wish to query the database. - * Select `HTTPS` to open port `443` for secure communication between - PostgreSQL and a web server. + * Select `HTTPS` to open port `443` for secure communication between + PostgreSQL and a web server. - * Select `SSH` to open port `22` for SSH connections. + * Select `SSH` to open port `22` for SSH connections. * Use the `Sources` drop-down to select the IP address(es) that will be allowed to connect to the port. - * Choose `My IP:x.x.x.x` to open a port for the detected IP address - from which you are connected. - * Choose `All IPV4` to allow connections to the selected port from any - source. This setting is not recommended for connections to the - database server. + * Choose `My IP:x.x.x.x` to open a port for the detected IP address + from which you are connected. + * Choose `All IPV4` to allow connections to the selected port from any + source. This setting is not recommended for connections to the + database server.
| When the dialog opens, click in the `Backup Stores` field or select from the | ||
| icons on the map to choose the backup stores you wish to make available to | ||
| your cluster. When you've identified the clusters backup stores, select the | ||
| `Update Backup Stores` button to update the cluster. |
There was a problem hiding this comment.
Fix possessive grammar in “cluster’s backup stores”.
This reads as plural “clusters” instead of possessive.
✏️ Suggested edit
-when you've identified the clusters backup stores, select the
+when you've identified the cluster's backup stores, select the📝 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.
| When the dialog opens, click in the `Backup Stores` field or select from the | |
| icons on the map to choose the backup stores you wish to make available to | |
| your cluster. When you've identified the clusters backup stores, select the | |
| `Update Backup Stores` button to update the cluster. | |
| When the dialog opens, click in the `Backup Stores` field or select from the | |
| icons on the map to choose the backup stores you wish to make available to | |
| your cluster. When you've identified the cluster's backup stores, select the | |
| `Update Backup Stores` button to update the cluster. |
🤖 Prompt for AI Agents
In `@docs/cloud/cluster/backup_store.md` around lines 68 - 71, Replace the
incorrect plural phrase "clusters backup stores" with the possessive "cluster's
backup stores" in the sentence inside the Backup Stores dialog instructions;
update the line that reads "When you've identified the clusters backup stores,
select the `Update Backup Stores` button to update the cluster." to use the
possessive form so it becomes "When you've identified the cluster's backup
stores, select the `Update Backup Stores` button to update the cluster."
This content contains changes for these pages:
http://127.0.0.1:9000/cloud/cluster/create_cluster/
https://docs.pgedge.com/cloud/database/create_db/
Summary by CodeRabbit