Conversation
✅ Deploy Preview for pelica ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughReorganizes documentation structure and navigation: converts React Admonition components to Markdown directive syntax, adds standalone/dockerized installation pages for Panel and Wings, removes several legacy docs, and updates sidebars, footer links, and internal references. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 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 |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
🧹 Nitpick comments (7)
docs/comparison.mdx (2)
16-90: Consider reducing third-party badge image dependency in the roadmap tabs.Using dozens of
img.shields.ioimages creates many external requests on a single page and makes docs rendering dependent on a third-party uptime/latency. Prefer local status tokens (e.g., text/emojis/CSS badges) for reliability.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/comparison.mdx` around lines 16 - 90, Replace the external img.shields.io badges used inside the TabItem blocks (the markdown strings like , , and ) with local, non-network-dependent status tokens: either simple text with emojis (e.g., "✅ Done", "🟦 Planned", "🟠 In Progress"), local SVG/PNG assets served from the repo, or CSS-styled badge spans (create reusable CSS classes like .badge-done, .badge-planned, .badge-progress and replace the inline image markdown across all TabItem entries), so the TabItem elements render without external requests and are consistent across the roadmap.
8-10: Remove 4-space indentation from admonition content to prevent code block rendering.Line 9 is indented by four spaces inside
:::info. Under CommonMark rules (which Docusaurus MDX follows), content indented 4+ spaces renders as an indented code block. Remove the indentation to render the text normally.Proposed fix
:::info - Want to see these changes in action? Check out our [Demo](https://demo.pelican.dev)! +Want to see these changes in action? Check out our [Demo](https://demo.pelican.dev)! :::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/comparison.mdx` around lines 8 - 10, The admonition content in docs/comparison.mdx is indented four spaces causing it to render as a code block; edit the text inside the :::info admonition (the line starting "Want to see these changes in action? Check out our [Demo](https://demo.pelican.dev)!") and remove the leading four-space indentation so the sentence is flush with the admonition marker (no extra spaces) and renders as normal paragraph text.docs/guides/database-hosts.mdx (1)
42-44: Same indentation pattern observed.For consistency with standard Docusaurus admonition formatting, consider removing the extra leading whitespace.
📝 Suggested fix
:::tip - Users will later see the host as their database endpoint. Therefore, you should set it to a public ip or FQDN and not to `localhost` for example. +Users will later see the host as their database endpoint. Therefore, you should set it to a public ip or FQDN and not to `localhost` for example. :::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/database-hosts.mdx` around lines 42 - 44, The admonition block starting with ":::tip" has extra leading indentation; remove the leading spaces before the ":::tip" line and the following content lines so the admonition uses standard Docusaurus formatting (i.e., align ":::tip" and its inner text at column zero) to ensure consistent rendering.docs/guides/change-panel-domain.mdx (1)
19-21: Same indentation note applies here.Similar to the previous file, the content inside
:::infoblocks has extra leading whitespace. Consider removing for consistency.📝 Suggested fix
:::info[Using HTTPS?] - If you're using HTTPS, remember to also change the SSL paths in the config file to match your new domain and [generate a new certificate](../install/misc/ssl). +If you're using HTTPS, remember to also change the SSL paths in the config file to match your new domain and [generate a new certificate](../install/misc/ssl). :::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/change-panel-domain.mdx` around lines 19 - 21, The info admonition block starting with :::info[Using HTTPS?] contains extra leading whitespace before its inner lines; remove the leading spaces so the sentence "If you're using HTTPS, remember to also change the SSL paths..." and the link "[generate a new certificate](../install/misc/ssl)" are left-aligned directly under the :::info header (i.e., ensure the content inside the :::info[Using HTTPS?] block has no extra indentation), keeping the admonition syntax and text unchanged.docs/guides/uninstalling.mdx (1)
10-12: Consider removing extra indentation inside the danger block.The content inside the
:::dangerblock appears to have extra leading whitespace (4 spaces). In Docusaurus MDX admonitions, this indentation is typically unnecessary and may affect rendering depending on the Docusaurus version.📝 Suggested fix
:::danger - **You will lose all data and this action is irreversible!** +**You will lose all data and this action is irreversible!** :::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/uninstalling.mdx` around lines 10 - 12, The admonition content inside the :::danger block has extra leading spaces that may break Docusaurus MDX rendering; remove the 4-space indentation so the text "**You will lose all data and this action is irreversible!**" is directly under the :::danger marker (i.e., unindent the admonition body), ensuring the admonition block renders correctly.docs/install/panel/standalone.mdx (2)
53-53: Prefer a pinned Panel release overlatestfor deterministic installs.Using
latestcan make troubleshooting/repro harder when instructions change over time.📦 Suggested command pattern
-curl -L https://github.com/pelican-dev/panel/releases/latest/download/panel.tar.gz | sudo tar -xzv +PANEL_VERSION="<pin-release-tag>" +curl -L "https://github.com/pelican-dev/panel/releases/download/${PANEL_VERSION}/panel.tar.gz" | sudo tar -xzv🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/install/panel/standalone.mdx` at line 53, Replace the unpinned download that uses "latest" with a pinned release reference so installs are deterministic; update the curl/tar invocation (the line that pipes curl -L https://github.com/pelican-dev/panel/releases/latest/download/panel.tar.gz | sudo tar -xzv) to reference a specific release tag or version variable (e.g., vX.Y.Z) and document where to update that version; ensure the docs include a short note encouraging maintainers to update the pinned version when releasing new Panel versions.
503-504: Polish the advanced callout tone and link style.This section repeats phrasing and uses a non-canonical relative path form; tightening it makes the note cleaner.
🧹 Suggested wording cleanup
-Make sure to read the [MySQL guide](./../misc/mysql) first if you want to use MySQL/ MariaDB instead of SQLite! -If you want to use Redis make sure to read the [Redis guide](./../misc/redis) first. +Read the [MySQL guide](../misc/mysql) first if you want MySQL/MariaDB instead of SQLite. +For Redis, read the [Redis guide](../misc/redis) first.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/install/panel/standalone.mdx` around lines 503 - 504, Replace the duplicated, informal callout lines starting with "Make sure to read the [MySQL guide](./../misc/mysql) first..." and "If you want to use Redis make sure to read the [Redis guide](./../misc/redis) first." with a single concise sentence that uses canonical relative links and tightened tone, e.g. reference "MySQL/MariaDB" (remove the extra space in "MySQL/ MariaDB"), use "../misc/mysql" and "../misc/redis" as the link targets, and present both guides in one clear line such as "See the MySQL/MariaDB and Redis setup guides: [MySQL guide](../misc/mysql) and [Redis guide](../misc/redis)." Ensure the replacement preserves the note intent and fixes the non-canonical "./../" paths and duplicated phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/comparison.mdx`:
- Line 93: Change the heading "Comparison with other Software" to use lowercase
"software" for consistency and clarity, and replace the ambiguous phrase "the
others" (found in the paragraph around lines 112–115) with a specific reference
(e.g., "other tools", "competing products", or name the categories/softwares
being compared) so the reader knows exactly which items are meant; update the
heading text and the paragraph that currently uses "the others" to the chosen
precise wording to maintain consistent user-facing language.
In `@docs/install/install.mdx`:
- Around line 32-34: The admonition block starting with the marker ":::info" is
closed incorrectly with "::"; update the closing marker to ":::". Locate the
opening ":::info" line in docs/install/install.mdx and replace the trailing "::"
with the correct closing ":::", ensuring the MDX admonition block for the
sentence "A Panel can have multiple Nodes but a Node is always tied to just one
Panel." is properly closed.
- Around line 8-10: The admonition blocks in the markdown have incorrect
indentation and a mismatched closing fence: remove the leading 4-space
indentation from the admonition body lines (e.g., the lines currently indented
under the opening ":::warning" so the body is flush with the directive) for all
occurrences noted (lines around the first admonition and the other occurrences
at 14-16), and replace the incorrect closing fence `::` with the correct `:::`
to match the opening (also fix the similar mismatch at the second occurrence
around 32-34) so each Docusaurus admonition uses a non-indented body and a
matching triple-colon close.
In `@docs/install/panel/dockerized.mdx`:
- Around line 43-45: The docs are inconsistent: the compose example uses
LE_EMAIL while later steps and the custom Caddyfile refer to ADMIN_EMAIL; update
the file so a single variable name is used throughout (preferably LE_EMAIL to
match the compose example) by replacing all instances of ADMIN_EMAIL with
LE_EMAIL (including in the setup steps and Caddyfile examples) and verify
references in functions/sections that mention ADMIN_EMAIL are renamed to
LE_EMAIL to keep examples and instructions consistent.
- Around line 64-80: The compose snippet incorrectly references the YAML anchor
*mail-environment that doesn't exist, includes an unnecessary build: . directive
for a quick-start using ghcr.io images, and mismatches the environment variable
name (LE_EMAIL vs ADMIN_EMAIL); fix by removing the non-existent anchor
reference (or define &mail-environment earlier if mail settings are required),
remove the build: . line from the service block, and pick a single env var name
(rename occurrences of LE_EMAIL to ADMIN_EMAIL or vice versa) so the environment
key used in the compose example and the setup instructions are identical; look
for the service block with "build: .", the environment mapping containing
XDG_DATA_HOME and <<: [*panel-environment, *mail-environment], and occurrences
of LE_EMAIL/ADMIN_EMAIL to update consistently.
In `@docs/install/panel/standalone.mdx`:
- Line 17: Update the copy for consistency: change "Debian based" to
"Debian-based", normalize "Webserver" to "web server" (lowercase two-word form),
and replace "auto create" with "automatically create" (or "auto-create" if you
prefer a hyphenated adjective) across the document where those phrases appear;
search for the exact strings "Debian based", "Webserver", and "auto create" and
replace them with the recommended forms to ensure uniform wording throughout the
file.
In `@docs/install/wings/dockerized.mdx`:
- Line 35: The "Advanced Options" anchor referenced by the link text "[Advanced
Options](`#advanced-options`)" is missing; either remove the link or add a
corresponding section header and content named "Advanced Options" that matches
the "#advanced-options" anchor; if adding, create a "## Advanced Options"
section after the current content that documents alternative Docker options
(external DB/Redis configuration, different cache/session/queue drivers and how
to configure them in the installer) so the anchor resolves and users find the
referenced details.
In `@docs/install/wings/standalone.mdx`:
- Line 26: Fix the minor spacing typo in the sentence that reads "If the result
doesn't contain `OpenVZ` or`LXC`, it should be fine." by inserting a space
between "or" and the backtick so it becomes "or `LXC`"; update the text in the
standalone.mdx content where that sentence appears.
In `@docs/troubleshooting.mdx`:
- Around line 60-63: Update the two wording errors in the Wings troubleshooting
bullets: change "a SSL certificate" to "an SSL certificate" in the fullchain.pem
bullet, and insert the missing word "to" so the sentence reads "you need to
update the token" (or preferably "you need to update the token in your
config.yml file") in the AccessDeniedHttpException bullet; ensure both corrected
phrases match surrounding style and punctuation.
In `@docusaurus.config.ts`:
- Around line 82-83: Add a redirect entry mapping the old SSL URL to the new one
so links to /docs/guides/ssl don’t 404; in the Docusaurus redirects array (the
same config object that contains entries like { to: '/docs/install/...', from:
[...] }), add '/docs/guides/ssl' (and optionally '/docs/guides/ssl/') to the
from list and point it to '/docs/install/misc/ssl' so requests to the removed
guide are redirected to the new path.
In `@src/pages/faq.mdx`:
- Around line 170-175: Update the two relative links that currently read
"./docs/plugins#install-a-plugin" and "./docs/plugins#create-a-plugin" to use
absolute paths "/docs/plugins#install-a-plugin" and
"/docs/plugins#create-a-plugin" so they resolve correctly (the affected markdown
is the details entries with summaries "How do you install plugins?" and "How do
you create plugins?").
---
Nitpick comments:
In `@docs/comparison.mdx`:
- Around line 16-90: Replace the external img.shields.io badges used inside the
TabItem blocks (the markdown strings like
,
, and ) with local,
non-network-dependent status tokens: either simple text with emojis (e.g., "✅
Done", "🟦 Planned", "🟠 In Progress"), local SVG/PNG assets served from the
repo, or CSS-styled badge spans (create reusable CSS classes like .badge-done,
.badge-planned, .badge-progress and replace the inline image markdown across all
TabItem entries), so the TabItem elements render without external requests and
are consistent across the roadmap.
- Around line 8-10: The admonition content in docs/comparison.mdx is indented
four spaces causing it to render as a code block; edit the text inside the
:::info admonition (the line starting "Want to see these changes in action?
Check out our [Demo](https://demo.pelican.dev)!") and remove the leading
four-space indentation so the sentence is flush with the admonition marker (no
extra spaces) and renders as normal paragraph text.
In `@docs/guides/change-panel-domain.mdx`:
- Around line 19-21: The info admonition block starting with :::info[Using
HTTPS?] contains extra leading whitespace before its inner lines; remove the
leading spaces so the sentence "If you're using HTTPS, remember to also change
the SSL paths..." and the link "[generate a new
certificate](../install/misc/ssl)" are left-aligned directly under the :::info
header (i.e., ensure the content inside the :::info[Using HTTPS?] block has no
extra indentation), keeping the admonition syntax and text unchanged.
In `@docs/guides/database-hosts.mdx`:
- Around line 42-44: The admonition block starting with ":::tip" has extra
leading indentation; remove the leading spaces before the ":::tip" line and the
following content lines so the admonition uses standard Docusaurus formatting
(i.e., align ":::tip" and its inner text at column zero) to ensure consistent
rendering.
In `@docs/guides/uninstalling.mdx`:
- Around line 10-12: The admonition content inside the :::danger block has extra
leading spaces that may break Docusaurus MDX rendering; remove the 4-space
indentation so the text "**You will lose all data and this action is
irreversible!**" is directly under the :::danger marker (i.e., unindent the
admonition body), ensuring the admonition block renders correctly.
In `@docs/install/panel/standalone.mdx`:
- Line 53: Replace the unpinned download that uses "latest" with a pinned
release reference so installs are deterministic; update the curl/tar invocation
(the line that pipes curl -L
https://github.com/pelican-dev/panel/releases/latest/download/panel.tar.gz |
sudo tar -xzv) to reference a specific release tag or version variable (e.g.,
vX.Y.Z) and document where to update that version; ensure the docs include a
short note encouraging maintainers to update the pinned version when releasing
new Panel versions.
- Around line 503-504: Replace the duplicated, informal callout lines starting
with "Make sure to read the [MySQL guide](./../misc/mysql) first..." and "If you
want to use Redis make sure to read the [Redis guide](./../misc/redis) first."
with a single concise sentence that uses canonical relative links and tightened
tone, e.g. reference "MySQL/MariaDB" (remove the extra space in "MySQL/
MariaDB"), use "../misc/mysql" and "../misc/redis" as the link targets, and
present both guides in one clear line such as "See the MySQL/MariaDB and Redis
setup guides: [MySQL guide](../misc/mysql) and [Redis guide](../misc/redis)."
Ensure the replacement preserves the note intent and fixes the non-canonical
"./../" paths and duplicated phrasing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e16880f1-e045-48ee-8332-4b3abd60ccfb
⛔ Files ignored due to path filters (1)
static/img/docs/example_setup.pngis excluded by!**/*.png
📒 Files selected for processing (38)
README.mddocs/about.mdxdocs/comparison.mdxdocs/glossary.mdxdocs/guides/change-panel-domain.mdxdocs/guides/database-hosts.mdxdocs/guides/disk-quotas/ext4-xfs.mdxdocs/guides/disk-quotas/index.mdxdocs/guides/docker.mdxdocs/guides/eggs/creating-a-custom-egg.mdxdocs/guides/eggs/creating-a-custom-yolk.mdxdocs/guides/mounts.mdxdocs/guides/php-upgrade.mdxdocs/guides/ssl.mdxdocs/guides/uninstalling.mdxdocs/index.mdxdocs/install/install.mdxdocs/install/misc/mysql.mdxdocs/install/misc/redis.mdxdocs/install/misc/ssl.mdxdocs/install/panel/dockerized.mdxdocs/install/panel/standalone.mdxdocs/install/wings/dockerized.mdxdocs/install/wings/standalone.mdxdocs/panel/advanced/artisan.mdxdocs/panel/getting-started.mdxdocs/panel/optional-config.mdxdocs/panel/panel-setup.mdxdocs/panel/update.mdxdocs/plugins.mdxdocs/troubleshooting.mdxdocs/wings/install.mdxdocs/wings/optional-config.mdxdocs/wings/update.mdxdocusaurus.config.tssidebars.tssrc/pages/faq.mdxsrc/pages/index.tsx
💤 Files with no reviewable changes (11)
- docs/guides/docker.mdx
- docs/guides/ssl.mdx
- docs/wings/install.mdx
- docs/wings/optional-config.mdx
- docs/panel/update.mdx
- docs/about.mdx
- docs/panel/advanced/artisan.mdx
- docs/panel/optional-config.mdx
- docs/panel/panel-setup.mdx
- docs/panel/getting-started.mdx
- docs/wings/update.mdx
📜 Review details
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-02T01:29:01.167Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:01.167Z
Learning: In the Pelican docs repo (pelican-dev/docs), trailing slashes on device paths (e.g., /dev/sdb/) in the disk quotas guidance should not be flagged. Accept both forms and ensure this exception is only applied to device path examples in documentation; maintain standard validation for other content.
Applied to files:
docs/guides/disk-quotas/ext4-xfs.mdxdocs/plugins.mdxdocs/comparison.mdxdocs/install/wings/dockerized.mdxdocs/install/install.mdxdocs/install/misc/ssl.mdxdocs/guides/disk-quotas/index.mdxdocs/index.mdxdocs/install/panel/dockerized.mdxdocs/guides/eggs/creating-a-custom-egg.mdxdocs/install/wings/standalone.mdxdocs/guides/database-hosts.mdxdocs/guides/uninstalling.mdxdocs/guides/php-upgrade.mdxdocs/glossary.mdxdocs/install/panel/standalone.mdxdocs/troubleshooting.mdxdocs/install/misc/redis.mdxdocs/guides/change-panel-domain.mdxdocs/install/misc/mysql.mdxdocs/guides/eggs/creating-a-custom-yolk.mdxdocs/guides/mounts.mdx
🪛 LanguageTool
docs/plugins.mdx
[grammar] ~24-~24: Use a hyphen to join words.
Context: ...-dev/plugins)! It contains free and open source plugins created by the Pelican te...
(QB_NEW_EN_HYPHEN)
[grammar] ~371-~371: Use a hyphen to join words.
Context: ...panel! You also don't have to open source your plugin code. But if you do w...
(QB_NEW_EN_HYPHEN)
docs/install/install.mdx
[style] ~15-~15: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1365 characters long)
Context: ...s? Check out our Glossary! ::: First you will need to install the...
(EN_EXCESSIVE_EXCLAMATION)
docs/install/misc/ssl.mdx
[grammar] ~12-~12: Ensure spelling is correct
Context: ...e plugin so you won't have to stop your webserver. <TabItem value="certbot_ng...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~45-~45: Ensure spelling is correct
Context: ... plugin, you won't need to restart your webserver to have the certificate applied assumin...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~46-~46: Ensure spelling is correct
Context: ...ming that you've already configured the webservers to use SSL as instructed in the [web se...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~97-~97: Use a hyphen to join words.
Context: ... get an Insecure Connection or SSL/TLS related error when trying to access your...
(QB_NEW_EN_HYPHEN)
[style] ~120-~120: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...d to restart Wings as not every service is able to automatically apply an updated certific...
(BE_ABLE_TO)
docs/guides/disk-quotas/index.mdx
[style] ~7-~7: Consider using a synonym to be more concise.
Context: ...separate partition. ::: ## There are a lot of notices here for a reason! :::danger ...
(A_LOT_OF)
docs/install/panel/standalone.mdx
[grammar] ~17-~17: Use a hyphen to join words.
Context: ... This documentation will assume a Debian based OS with apt. :::info SQLite sup...
(QB_NEW_EN_HYPHEN)
[grammar] ~29-~29: Ensure spelling is correct
Context: ...lite3andfpm`. You will also need a Webserver. Currently, Apache, NGINX or Caddy ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~36-~36: Consider using a different verb to strengthen your wording.
Context: ...arandunzip`. :::warning Please make sure you installed all needed dependenci...
(MAKE_SURE_ENSURE)
[grammar] ~75-~75: Ensure spelling is correct
Context: ...create SSL certificates, otherwise your webserver will fail to start. See the [Creati...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~460-~460: Use a hyphen to join words.
Context: ...:setupwill, if it does not exist, auto create the required.env` file and gene...
(QB_NEW_EN_HYPHEN)
[grammar] ~473-~473: Ensure spelling is correct
Context: ...missions on the Panel files so that the webserver can use them correctly. ```sh sudo chm...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~503-~503: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3883 characters long)
Context: ... to use MySQL/ MariaDB instead of SQLite! If you want to use Redis make sure ...
(EN_EXCESSIVE_EXCLAMATION)
[style] ~504-~504: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .../ MariaDB instead of SQLite! If you want to use Redis make sure to read the [Redis ...
(REP_WANT_TO_VB)
docs/troubleshooting.mdx
[style] ~104-~104: Consider using a different verb to strengthen your wording.
Context: .../pelican-panel) and we will be happy to help you! ::: ### Check node settings If t...
(HELP_ASSIST)
docs/install/misc/mysql.mdx
[style] ~47-~47: Consider a more expressive alternative.
Context: ...d have access to the panel database. To do this, simply run the command below. ``...
(DO_ACHIEVE)
🔇 Additional comments (30)
docs/guides/eggs/creating-a-custom-yolk.mdx (1)
3-4: LGTM!The added subtitle provides helpful context about what a Yolk is (Docker image for Pelican), which is useful for users unfamiliar with the terminology. The formatting is consistent with other documentation pages in this PR.
README.md (1)
1-12: LGTM!Minor formatting improvements with proper spacing after headings and trailing newline at end-of-file.
docs/guides/change-panel-domain.mdx (1)
6-7: LGTM!The introductory sentence provides helpful context, and the link path update to
../install/misc/sslcorrectly reflects the documentation reorganization.src/pages/index.tsx (2)
28-29: LGTM!The Install button link update from
/docs/panel/getting-startedto/docs/installcorrectly aligns with the new documentation structure. The sidebar configuration confirms this path maps to theinstall/installdocument.
1-1: LGTM!Minor spacing adjustments in imports and destructuring for style consistency.
docs/install/misc/redis.mdx (1)
3-4: LGTM!The added introductory sentence is consistent with other documentation pages in this PR and provides helpful context for the guide.
docs/glossary.mdx (1)
22-24: Image asset confirmed to exist.The referenced image at
/img/docs/example_setup.pngis present in the repository.src/pages/faq.mdx (2)
10-13: LGTM!The MDX admonition directive syntax is correct, and the link to
/docs/installproperly points to the new installation documentation entry point as confirmed by thedocs/install/install.mdxcontext snippet.
95-103: LGTM!The licensing summary admonition block is correctly formatted with the MDX directive syntax.
docs/guides/php-upgrade.mdx (1)
6-8: LGTM!The introductory text is concise and clear. The changes align with the documentation style updates across the repo.
docs/guides/disk-quotas/ext4-xfs.mdx (4)
10-12: LGTM!The warning admonition is correctly formatted, and the relative link
./properly references the parent index page (docs/guides/disk-quotas/index.mdx).
21-25: LGTM!All warning admonition blocks in the filesystem configuration sections are correctly converted to MDX directive syntax with proper indentation.
Also applies to: 43-45, 65-69, 93-95, 116-120
127-135: LGTM!The danger admonition blocks for the advanced quota management section are correctly formatted.
228-230: LGTM!The TODO note admonition is correctly formatted. The pending XFS documentation is appropriately flagged.
docs/guides/disk-quotas/index.mdx (3)
1-5: LGTM!The heading simplification and tip admonition conversion are correctly implemented.
9-23: LGTM!The danger, warning, and info admonition blocks are correctly converted to MDX directive syntax with proper formatting.
25-27: LGTM!The link to the EXT4/XFS documentation uses the correct relative path format for the same directory.
docs/install/wings/standalone.mdx (2)
89-109: LGTM!The systemd service file configuration is well-structured with appropriate dependencies on Docker, restart policies, and resource limits.
66-70: The SSL documentation file exists atdocs/install/misc/ssl.mdx, and the relative path../misc/sslcorrectly resolves from the current file location. No action needed.docs/guides/eggs/creating-a-custom-egg.mdx (3)
3-3: LGTM!The introductory sentence provides helpful context for the guide.
181-186: LGTM!The note block clearly explains the different variable syntax contexts (startup commands, configuration parsers, and shell scripts), which is valuable for users creating custom eggs.
188-198: LGTM!The new "In Install Scripts" example section with the shell script block provides a practical demonstration of variable usage in install scripts.
docs/install/wings/dockerized.mdx (2)
5-7: LGTM!The danger admonition appropriately warns users about Docker familiarity requirements.
39-77: LGTM!The Docker Compose configuration is well-structured with:
- Appropriate volume mounts for Docker socket, containers, config, data, and logs
- Reasonable network configuration with a dedicated bridge network
- Helpful comments for optional SSL and migration volumes
docs/install/misc/mysql.mdx (3)
1-3: LGTM!The heading and introductory sentence clearly indicate this guide covers MariaDB installation and setup.
22-24: LGTM!The login command is now properly formatted as a code block.
32-34: LGTM!The SQL command for creating the user is correct and follows best practices by restricting connections to localhost (127.0.0.1).
docs/install/panel/standalone.mdx (1)
74-77: SSL cross-link migration looks correct.Nice update pointing to the new install-area SSL guide location.
sidebars.ts (2)
18-63: Installation sidebar restructure is clear and coherent.The new Installation grouping with Panel/Wings/Misc categories is organized well and improves discoverability.
68-99: Guides hierarchy update looks good.Nesting Eggs and linking Disk Quotas to its index doc makes the section easier to navigate.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (3)
docs/wings/install/dockerized.mdx (1)
40-40:⚠️ Potential issue | 🟡 MinorMissing "Advanced Options" section referenced by anchor link.
Line 40 references
[Advanced Options](#advanced-options)but no corresponding section exists in this file. Either add the section or remove the reference.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/wings/install/dockerized.mdx` at line 40, The doc references an anchor link "[Advanced Options](`#advanced-options`)" that doesn't exist; either add a corresponding "Advanced Options" section header (e.g., a Markdown/MDX heading like "## Advanced Options" with the advanced configuration details) to satisfy the link or remove/replace the link in the paragraph; update the text that mentions Docker advanced options near the referenced sentence so the anchor "Advanced Options" is present as a heading name and includes the intended content.docs/troubleshooting.mdx (1)
65-65:⚠️ Potential issue | 🟡 MinorFix grammar: "a SSL" → "an SSL".
The article should be "an" before "SSL" since the pronunciation starts with a vowel sound.
✏️ Proposed fix
- * `open /etc/letsencrypt/live/_____________/fullchain.pem: no such file or directory`: The SSL certificate for wings is missing, see [this guide](./guides/ssl) for creating a SSL certificate. + * `open /etc/letsencrypt/live/_____________/fullchain.pem: no such file or directory`: The SSL certificate for Wings is missing; see [this guide](./guides/ssl) for creating an SSL certificate.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/troubleshooting.mdx` at line 65, The sentence in the troubleshooting entry uses the incorrect article "a" before "SSL"; update the phrase "`a SSL certificate for wings is missing`" to use the correct article by changing it to "`an SSL certificate for wings is missing`" so the line reads: "`open /etc/letsencrypt/live/_____________/fullchain.pem: no such file or directory`: The SSL certificate for wings is missing, see [this guide](./guides/ssl) for creating an SSL certificate." Ensure only the article is changed and punctuation/links remain unchanged.docs/panel/install/dockerized.mdx (1)
68-70:⚠️ Potential issue | 🟠 MajorRemove
build: .from the quick-start compose snippet.This guide already uses
ghcr.io/pelican-dev/panel:latest; keepingbuild: .introduces unnecessary local-build behavior in a quick-start path.Suggested fix
panel: image: ghcr.io/pelican-dev/panel:latest - build: . restart: unless-stopped🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/panel/install/dockerized.mdx` around lines 68 - 70, The quick-start docker-compose snippet mixes a prebuilt image with a local build; remove the unnecessary "build: ." key so the service uses ghcr.io/pelican-dev/panel:latest only. Open the docker-compose snippet that defines image: ghcr.io/pelican-dev/panel:latest and delete the build: . line (leaving restart: unless-stopped), then verify the snippet runs purely from the published image.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/guides/ssl.mdx`:
- Line 51: The link currently uses the incorrect fragment
"#webserver-configuration" in the link text "[web server configuration
step](../panel/install/standalone#webserver-configuration)"; open the target
standalone page and copy its actual heading slug (the generated anchor for the
"web server configuration" heading) and replace "#webserver-configuration" with
that exact slug so the anchor navigates correctly (ensure formatting follows the
repository's MDX heading-to-slug rules, e.g., lowercase and hyphenated if
applicable).
In `@docs/index.mdx`:
- Line 14: Edit the onboarding wording to improve grammar and clarity: replace
the sentence that currently reads "If you notice anything that raises a concern,
please create a [Github security advisory]... or reach out directly to
**team@pelican.dev**" with a clearer variant such as "If you notice anything
concerning, please create a GitHub security advisory or contact
team@pelican.dev." Apply the same polish to the other instances flagged (the
sentences at the other specified locations) so phrasing is concise, consistent
(e.g., "GitHub" capitalization), and free of extraneous whitespace or
punctuation.
In `@docs/troubleshooting.mdx`:
- Line 114: Replace the misspelled word "successfull" with "successful" in the
sentence "If the connection checks above were both successfull you might have
misconfigured the Node settings in the Panel." so the line reads "If the
connection checks above were both successful you might have misconfigured the
Node settings in the Panel."; update the documentation text accordingly to
correct the typo.
In `@src/pages/faq.mdx`:
- Around line 168-170: The FAQ answer for "How are plugins installed?" currently
links to ./docs/panel/plugins#create-a-plugin; update that anchor to
./docs/panel/plugins#install-a-plugin so the summary "How are plugins
installed?" points to the correct section (replace the fragment in the existing
link).
---
Duplicate comments:
In `@docs/panel/install/dockerized.mdx`:
- Around line 68-70: The quick-start docker-compose snippet mixes a prebuilt
image with a local build; remove the unnecessary "build: ." key so the service
uses ghcr.io/pelican-dev/panel:latest only. Open the docker-compose snippet that
defines image: ghcr.io/pelican-dev/panel:latest and delete the build: . line
(leaving restart: unless-stopped), then verify the snippet runs purely from the
published image.
In `@docs/troubleshooting.mdx`:
- Line 65: The sentence in the troubleshooting entry uses the incorrect article
"a" before "SSL"; update the phrase "`a SSL certificate for wings is missing`"
to use the correct article by changing it to "`an SSL certificate for wings is
missing`" so the line reads: "`open
/etc/letsencrypt/live/_____________/fullchain.pem: no such file or directory`:
The SSL certificate for wings is missing, see [this guide](./guides/ssl) for
creating an SSL certificate." Ensure only the article is changed and
punctuation/links remain unchanged.
In `@docs/wings/install/dockerized.mdx`:
- Line 40: The doc references an anchor link "[Advanced
Options](`#advanced-options`)" that doesn't exist; either add a corresponding
"Advanced Options" section header (e.g., a Markdown/MDX heading like "##
Advanced Options" with the advanced configuration details) to satisfy the link
or remove/replace the link in the paragraph; update the text that mentions
Docker advanced options near the referenced sentence so the anchor "Advanced
Options" is present as a heading name and includes the intended content.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 17eed88b-abef-4233-87a0-a443c04e1a8c
📒 Files selected for processing (21)
docs/comparison.mdxdocs/glossary.mdxdocs/guides/change-panel-domain.mdxdocs/guides/database-hosts.mdxdocs/guides/ssl.mdxdocs/guides/uninstalling.mdxdocs/index.mdxdocs/panel/advanced/mysql.mdxdocs/panel/advanced/redis.mdxdocs/panel/install/dockerized.mdxdocs/panel/install/standalone.mdxdocs/panel/plugins.mdxdocs/panel/update.mdxdocs/troubleshooting.mdxdocs/wings/install/dockerized.mdxdocs/wings/install/standalone.mdxdocs/wings/update.mdxdocusaurus.config.tssidebars.tssrc/pages/faq.mdxsrc/pages/index.tsx
🚧 Files skipped from review as they are similar to previous changes (6)
- docs/guides/change-panel-domain.mdx
- docs/comparison.mdx
- docs/wings/update.mdx
- docusaurus.config.ts
- docs/guides/database-hosts.mdx
- docs/panel/update.mdx
📜 Review details
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2026-02-02T01:29:01.167Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:01.167Z
Learning: In the Pelican docs repo (pelican-dev/docs), trailing slashes on device paths (e.g., /dev/sdb/) in the disk quotas guidance should not be flagged. Accept both forms and ensure this exception is only applied to device path examples in documentation; maintain standard validation for other content.
Applied to files:
docs/index.mdxdocs/guides/uninstalling.mdxdocs/wings/install/dockerized.mdxdocs/panel/advanced/redis.mdxdocs/panel/advanced/mysql.mdxdocs/wings/install/standalone.mdxdocs/panel/install/dockerized.mdxdocs/panel/install/standalone.mdxdocs/guides/ssl.mdxdocs/glossary.mdxdocs/panel/plugins.mdxdocs/troubleshooting.mdx
📚 Learning: 2026-02-02T01:29:12.197Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:12.197Z
Learning: In the Pelican documentation repository (pelican-dev/docs), trailing slashes on device paths like `/dev/sdb/` in the disk quotas documentation are acceptable and should not be flagged.
Applied to files:
src/pages/faq.mdx
🪛 LanguageTool
docs/index.mdx
[uncategorized] ~14-~14: The official name of this software platform is spelled with a capital “H”.
Context: ...that raises a concern, please create a [Github security advisory](https://github.com/p...
(GITHUB)
docs/panel/advanced/mysql.mdx
[style] ~52-~52: Consider a more expressive alternative.
Context: ...d have access to the panel database. To do this, simply run the command below. ``...
(DO_ACHIEVE)
docs/panel/install/standalone.mdx
[style] ~41-~41: Consider using a different verb to strengthen your wording.
Context: ...arandunzip`. :::warning Please make sure you installed all needed dependenci...
(MAKE_SURE_ENSURE)
[style] ~510-~510: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 4005 characters long)
Context: ...t to use MySQL/MariaDB instead of SQLite! If you want to use Redis make sur...
(EN_EXCESSIVE_EXCLAMATION)
[style] ~511-~511: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...MariaDB instead of SQLite! If you want to use Redis make sure to read the [Redis ...
(REP_WANT_TO_VB)
docs/guides/ssl.mdx
[style] ~125-~125: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...d to restart Wings as not every service is able to automatically apply an updated certific...
(BE_ABLE_TO)
docs/panel/plugins.mdx
[grammar] ~29-~29: Use a hyphen to join words.
Context: ...-dev/plugins)! It contains free and open source plugins created by the Pelican te...
(QB_NEW_EN_HYPHEN)
[grammar] ~376-~376: Use a hyphen to join words.
Context: ...panel! You also don't have to open source your plugin code. But if you do w...
(QB_NEW_EN_HYPHEN)
docs/troubleshooting.mdx
[style] ~109-~109: Consider using a different verb to strengthen your wording.
Context: .../pelican-panel) and we will be happy to help you! ::: ### Check node settings If t...
(HELP_ASSIST)
[grammar] ~114-~114: Ensure spelling is correct
Context: ...f the connection checks above were both successfull you might have misconfigured the Node s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~143-~143: Ensure spelling is correct
Context: ...r proxy settings! Also make sure your webserver and/or proxy have a high enough upload ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (11)
docs/glossary.mdx (1)
1-29: LGTM!The front matter additions for pagination control and the switch from mermaid diagram to an image reference are appropriate. The glossary definitions are preserved.
docs/panel/advanced/mysql.mdx (1)
1-67: LGTM!The front matter additions and descriptive subtitle align with the documentation restructuring. The MySQL/MariaDB setup guide content is clear and well-organized.
docs/guides/uninstalling.mdx (1)
1-94: LGTM!The migration from Admonition components to Markdown directive syntax (:::danger) is consistent with the PR-wide pattern. The uninstallation steps are clear and well-organized.
docs/wings/install/standalone.mdx (2)
1-120: LGTM!This is a well-structured standalone Wings installation guide. The system requirements, Docker installation, configuration steps, and systemd daemonization instructions are comprehensive and clear.
71-75: SSL guide link is correct.The link
../../guides/sslfromdocs/wings/install/standalone.mdxresolves properly todocs/guides/ssl.mdx.docs/panel/plugins.mdx (1)
1-377: LGTM!The migration from Admonition components to Markdown directive syntax (:::warning, :::info, :::danger) is consistent throughout the file. The plugin documentation is comprehensive and well-organized.
docs/wings/install/dockerized.mdx (1)
44-82: LGTM!The Docker Compose configuration is well-structured with appropriate volume mounts, network configuration, and environment variables for running Wings in a container.
docs/troubleshooting.mdx (1)
22-29: LGTM on the updated link paths.The updated links to
./panel/install/standalone#dependenciesand./wings/install/standalone#configurecorrectly point to the new documentation structure. The relevant code snippets confirm these anchors exist.docs/panel/advanced/redis.mdx (1)
33-41: No broken anchor links detected.Verification found no existing links in the codebase that target the removed
#use-redis-as-driveranchor, so the removal of the "### Use Redis as driver" heading does not break any documentation references.sidebars.ts (1)
19-110: Sidebar reorganization is coherent and well-structured.The generated-index links plus nested Installation categories for Panel/Wings are consistent and improve discoverability.
src/pages/index.tsx (1)
28-29: CTA update to/docslooks correct.Good alignment with the new documentation entrypoint and navigation structure.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
docs/guides/ssl.mdx (2)
17-17: Consider standardizing "web server" terminology.The document uses both "webserver" (single word, lines 17, 50, 51) and "web server" (two words, lines 40, 105). "Web server" (two words) is the more standard form in technical documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/ssl.mdx` at line 17, Replace all occurrences of the single-word token "webserver" with the two-word standard form "web server" throughout the document (search for the literal "webserver" token used in the guide and update to "web server" to match existing instances), ensuring consistency in headings, body text, and command descriptions (e.g., the sentence about installing certbot's Nginx/Apache plugin and any other mentions).
100-106: Minor style improvements for readability.A couple of small refinements could improve readability:
- Line 102: "SSL/TLS related error" → "SSL/TLS-related error" (compound adjective)
- Line 125: "is able to" → "can" (more concise)
Suggested diff
-If you get an `Insecure Connection` or SSL/TLS related error when trying to access your panel or wings, the certificate has likely expired. +If you get an `Insecure Connection` or SSL/TLS-related error when trying to access your panel or wings, the certificate has likely expired.-You may also need to restart Wings as not every service is able to automatically apply an updated certificate: +You may also need to restart Wings as not every service can automatically apply an updated certificate:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/guides/ssl.mdx` around lines 100 - 106, Update the phrasing in docs/guides/ssl.mdx: change the phrase "SSL/TLS related error" to the hyphenated "SSL/TLS-related error" and replace the wordy "is able to" with the concise "can" wherever it appears in this guide to improve readability; locate these exact strings in the Troubleshooting section and update them accordingly.docs/index.mdx (1)
35-36: Use a doc-relative link for the glossary.Line 36 hardcodes
/docs/glossary. Docusaurus recommends relative doc/file links instead, and explicitly calls/docs/...links less portable because they do not automatically follow versioned/localized docs or future routing changes. (docusaurus.io)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/index.mdx` around lines 35 - 36, Replace the hardcoded absolute documentation link "[Glossary](/docs/glossary)" with a doc-relative link so Docusaurus will resolve versioned/localized routes (e.g., change to "[Glossary](glossary)" or the appropriate relative path), updating the link text in docs/index.mdx where the info admonition contains "Not sure what a specific term means? Check out our [Glossary](/docs/glossary)!" to use the doc-relative form.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@sidebars.ts`:
- Around line 25-35: Two sidebar category entries use link: { type:
'generated-index' } with label 'Installation' and thus collide at the same
generated route; update each category's link object to include a unique slug.
For the Panel category (the object containing items 'panel/install/standalone'
and 'panel/install/dockerized') add link: { type: 'generated-index', slug:
'panel/installation' } and for the Wings Installation category add link: { type:
'generated-index', slug: 'wings/installation' } so each generated-index resolves
to a distinct route.
---
Nitpick comments:
In `@docs/guides/ssl.mdx`:
- Line 17: Replace all occurrences of the single-word token "webserver" with the
two-word standard form "web server" throughout the document (search for the
literal "webserver" token used in the guide and update to "web server" to match
existing instances), ensuring consistency in headings, body text, and command
descriptions (e.g., the sentence about installing certbot's Nginx/Apache plugin
and any other mentions).
- Around line 100-106: Update the phrasing in docs/guides/ssl.mdx: change the
phrase "SSL/TLS related error" to the hyphenated "SSL/TLS-related error" and
replace the wordy "is able to" with the concise "can" wherever it appears in
this guide to improve readability; locate these exact strings in the
Troubleshooting section and update them accordingly.
In `@docs/index.mdx`:
- Around line 35-36: Replace the hardcoded absolute documentation link
"[Glossary](/docs/glossary)" with a doc-relative link so Docusaurus will resolve
versioned/localized routes (e.g., change to "[Glossary](glossary)" or the
appropriate relative path), updating the link text in docs/index.mdx where the
info admonition contains "Not sure what a specific term means? Check out our
[Glossary](/docs/glossary)!" to use the doc-relative form.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4fa6bc9b-a09b-403f-a002-2fc96f791975
📒 Files selected for processing (7)
docs/guides/ssl.mdxdocs/index.mdxdocs/panel/optional-config.mdxdocs/troubleshooting.mdxdocs/wings/optional-config.mdxsidebars.tssrc/pages/faq.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- src/pages/faq.mdx
- docs/panel/optional-config.mdx
📜 Review details
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-02T01:29:01.167Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:01.167Z
Learning: In the Pelican docs repo (pelican-dev/docs), trailing slashes on device paths (e.g., /dev/sdb/) in the disk quotas guidance should not be flagged. Accept both forms and ensure this exception is only applied to device path examples in documentation; maintain standard validation for other content.
Applied to files:
docs/guides/ssl.mdxdocs/index.mdxdocs/troubleshooting.mdxdocs/wings/optional-config.mdx
🪛 LanguageTool
docs/guides/ssl.mdx
[grammar] ~17-~17: Ensure spelling is correct
Context: ...e plugin so you won't have to stop your webserver. <TabItem value="certbot_ng...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~50-~50: Ensure spelling is correct
Context: ... plugin, you won't need to restart your webserver to have the certificate applied assumin...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~51-~51: Ensure spelling is correct
Context: ...ming that you've already configured the webservers to use SSL as instructed in the [web se...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~102-~102: Use a hyphen to join words.
Context: ... get an Insecure Connection or SSL/TLS related error when trying to access your...
(QB_NEW_EN_HYPHEN)
[style] ~125-~125: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...d to restart Wings as not every service is able to automatically apply an updated certific...
(BE_ABLE_TO)
docs/index.mdx
[uncategorized] ~14-~14: The official name of this software platform is spelled with a capital “H”.
Context: ...that raises a concern, please create a [Github security advisory](https://github.com/p...
(GITHUB)
[style] ~46-~46: Consider a more expressive alternative.
Context: ... you will need to create some Nodes. To do that, install and configure the Wings d...
(DO_ACHIEVE)
docs/troubleshooting.mdx
[style] ~109-~109: Consider using a different verb to strengthen your wording.
Context: .../pelican-panel) and we will be happy to help you! ::: ### Check node settings If t...
(HELP_ASSIST)
[grammar] ~143-~143: Ensure spelling is correct
Context: ...r proxy settings! Also make sure your webserver and/or proxy have a high enough upload ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/wings/optional-config.mdx
[style] ~152-~152: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...n each boot. Disable this when you have a very large amount of files and the server startup ...
(EN_WEAK_ADJECTIVE)
🔇 Additional comments (4)
docs/guides/ssl.mdx (4)
19-35: LGTM!The tabbed installation commands for certbot plugins are well-organized and provide appropriate options for different web server configurations.
37-51: LGTM!The anchor link to
#web-server-configurationcorrectly matches the target heading slug in the standalone installation guide. The info box about Wings-only machines is a helpful addition.
53-82: LGTM!The nested tabs for HTTP and DNS challenges are well-structured, providing clear options for different web server configurations and the standalone/DNS methods for Wings-only machines.
84-98: LGTM!The auto-renewal setup with cron is correctly configured, and the deploy hook ensures services are restarted after certificate renewal. The acme.sh recommendation for advanced users is a helpful addition.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/panel/install/dockerized.mdx (1)
68-70:⚠️ Potential issue | 🟡 MinorRemove the
build: .directive from the quick-start compose example.The
build: .directive is unnecessary and misleading in a quick-start guide that instructs users to pull pre-built images fromghcr.io. When bothimage:andbuild:are present, Docker Compose behavior depends onpull_policy, which can cause confusion for users following this guide. Users may wonder if they need source files to build locally.🛠️ Suggested fix
services: panel: image: ghcr.io/pelican-dev/panel:latest - build: . restart: unless-stopped🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/panel/install/dockerized.mdx` around lines 68 - 70, The quick-start docker-compose example includes both the image: ghcr.io/pelican-dev/panel:latest and build: . directives which is misleading; remove the build: . line from the compose snippet so the example only pulls the pre-built image (keep image: and restart: unless-stopped), ensuring users are not confused about needing local source files or building locally.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/panel/install/dockerized.mdx`:
- Around line 68-70: The quick-start docker-compose example includes both the
image: ghcr.io/pelican-dev/panel:latest and build: . directives which is
misleading; remove the build: . line from the compose snippet so the example
only pulls the pre-built image (keep image: and restart: unless-stopped),
ensuring users are not confused about needing local source files or building
locally.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f2076490-b4fe-424e-a5f9-19b815d75859
📒 Files selected for processing (8)
docs/guides/change-panel-domain.mdxdocs/guides/php-upgrade.mdxdocs/guides/ssl.mdxdocs/guides/uninstalling.mdxdocs/panel/install/dockerized.mdxdocs/panel/update.mdxdocs/troubleshooting.mdxsidebars.ts
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/panel/update.mdx
- docs/guides/change-panel-domain.mdx
- docs/guides/php-upgrade.mdx
📜 Review details
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-02T01:29:01.167Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:01.167Z
Learning: In the Pelican docs repo (pelican-dev/docs), trailing slashes on device paths (e.g., /dev/sdb/) in the disk quotas guidance should not be flagged. Accept both forms and ensure this exception is only applied to device path examples in documentation; maintain standard validation for other content.
Applied to files:
docs/panel/install/dockerized.mdxdocs/guides/ssl.mdxdocs/guides/uninstalling.mdxdocs/troubleshooting.mdx
🪛 LanguageTool
docs/troubleshooting.mdx
[style] ~109-~109: Consider using a different verb to strengthen your wording.
Context: .../pelican-panel) and we will be happy to help you! ::: ### Check node settings If t...
(HELP_ASSIST)
🔇 Additional comments (19)
docs/guides/uninstalling.mdx (3)
6-12: LGTM!The migration from React
Admonitioncomponent to Markdown admonition syntax (:::danger) is correct and follows Docusaurus conventions. The introductory text and data loss warning are clear and appropriately structured.
24-26: LGTM!The terminology standardization from "Webserver" to "Web server" (two words) is correct and improves consistency across the documentation.
65-65: LGTM!Good fix removing the extraneous space in "MySQL/MariaDB".
docs/panel/install/dockerized.mdx (3)
1-12: LGTM!The frontmatter and introduction section are clear and appropriate. The danger admonition properly warns users about Docker familiarity requirements.
98-104: LGTM!Environment variable documentation is now consistent, using
LE_EMAILthroughout as intended. The instructions clearly explain both required variables.
160-239: LGTM!The Advanced Options section is well-structured with clear examples for custom Caddyfile configuration and file upload limits. The
LE_EMAILvariable name is used consistently with the main compose example.docs/guides/ssl.mdx (4)
1-17: LGTM!The introduction and Certbot installation section are clear and well-structured. The tabbed approach for different web servers is user-friendly.
50-52: LGTM!The link to the web server configuration step now uses the correct anchor
#web-server-configuration, which matches the expected slug generated from the "Web server Configuration" heading.
53-82: LGTM!The nested tab structure for HTTP and DNS challenges is well-organized. The certbot commands are correct for each web server type.
84-129: LGTM!The Auto Renewal and Troubleshooting sections provide practical guidance. The cron job syntax is correct, and the manual renewal steps cover common scenarios well.
sidebars.ts (3)
25-37: LGTM!The Panel Installation category now has an explicit unique slug
/category/panel-installation, which prevents the routing collision that was previously flagged.
63-75: LGTM!The Wings Installation category correctly uses a unique slug
/category/wings-installation, preventing any collision with the Panel installation route.
80-116: LGTM!The Guides category is well-structured with appropriate link configurations. The Eggs subcategory uses
generated-indexfor auto-generated content, while Disk Quotas correctly usestype: 'doc'to link to an explicit index document.docs/troubleshooting.mdx (6)
2-3: LGTM!Pagination controls appropriately disabled for this standalone troubleshooting page.
22-28: LGTM!Link path updated to match the new documentation structure. The
#dependenciesanchor is confirmed to exist in the target file.
65-68: Previous grammatical fixes have been applied.The "an SSL certificate" and "you need to" corrections from previous review are now in place. Link paths are valid per the new documentation structure.
Minor remaining issues (lowercase "wings" instead of "Wings", inconsistent trailing punctuation) were noted in the previous review but not addressed—flagging here for visibility but not blocking.
74-80: LGTM!Clear and accurate guidance for port checking and NAT loopback troubleshooting.
107-115: LGTM!Admonition-to-Markdown directive conversion is consistent with the PR's documentation style migration. The "successful" typo has been corrected as noted in the previous review.
127-143: LGTM!Cronjob and upload limit guidance is accurate and properly references the relevant configuration settings.
1 participant
Summary by CodeRabbit