Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Update index, improved wording for better flow and clarity by rowebil · Pull Request #183 · pelican/docs · GitHub
Skip to content

Update index, improved wording for better flow and clarity - #183

Merged
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1
Dec 28, 2025
Merged

Update index, improved wording for better flow and clarity#183
notAreYouScared merged 2 commits into
pelican:mainfrom
rowebil:patch-1

Conversation

@rowebil

@rowebilrowebil commented Dec 27, 2025

Copy link
Copy Markdown
Contributor

Made some wording adjustments to improve flow and clarify.

Summary by CodeRabbit

  • Documentation
    • Tightened and consolidated product description, including a single-sentence highlight of Pelican and mention of Wings as the runtime environment.
    • Emphasized open-source access: browsing code, contributing improvements, and helping identify bugs/security issues.
    • Updated admonition wording and punctuation for clearer tone.
    • Clarified security disclosure guidance, advising responsible handling and discouraging public posting on GitHub.

✏️ Tip: You can customize this high-level summary in your review settings.

Made some wording adjustments to improve flow and polished wording for clarify.
@netlify

netlifyBot commented Dec 27, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit176867e
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/694f276d7ce3810007423d79
😎 Deploy Previewhttps://deploy-preview-183--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitaiBot commented Dec 27, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation edit to docs/index.mdx that tightens Pelican's landing description, expands open-source wording to include browsing, contributions, and bug/security identification, updates the warning admonition wording/formatting, adds a Wings runtime mention, and adjusts minor formatting.

Changes

Cohort / File(s)Summary
Landing page content
docs/index.mdx
Rewrite of Pelican description (condensed wording and bolding), broaden open-source phrasing to mention browsing, contributing, and identifying bugs/security issues, modify admonition title/punctuation and reword security disclosure guidance (avoid posting on GitHub), add mention of Wings runtime, and minor formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • rmartinoscar
  • Boy132

Poem

🐰 A quick hop through docs with delight,
New words tucked in bold and phrasing tight,
Open to browse, to help, and to mend,
Wings added in flight — together we tend. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the primary change—improving wording in the index file for better flow and clarity, which aligns with the file modifications documented in the raw summary.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7e2c51 and 176867e.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM! Improved narrative flow.

The consolidated sentence structure and emphasis on Pelican enhance readability and brand presence. The refined wording maintains professionalism while improving clarity.


42-42: Excellent expansion of the open-source invitation.

The updated wording is more comprehensive and actionable, explicitly inviting contributions and clearly distinguishing between bug identification and security issue reporting. This better communicates Pelican's open-source values.


44-46: Admonition improvements applied correctly.

The changes enhance professionalism:

  • Removed trailing period from the title (proper title formatting)
  • Softened "red flag" to "a concern" (more measured tone)
  • Applied correct "GitHub" capitalization (addressing the previous review feedback)

The security disclosure guidance is now clearer and maintains appropriate brand consistency.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 019f49e and f7e2c51.

📒 Files selected for processing (1)
  • docs/index.mdx
🔇 Additional comments (3)
docs/index.mdx (3)

12-12: LGTM!

The updated wording improves flow by consolidating the description into a single, more impactful sentence with appropriate emphasis on the "Pelican" brand name.


39-39: LGTM!

The revised description provides a clearer, more concise explanation of Pelican's architecture and its relationship with Pterodactyl and Wings.


42-42: LGTM!

The expanded description better communicates the benefits of open-source and encourages broader community participation beyond just security research.

Comment threaddocs/index.mdx Outdated
As per coderabbitai recommendation, fixed spelling of GitHub to proper capitalization.

@rmartinoscarrmartinoscar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution 👍

@notAreYouScared
notAreYouScared merged commit 266b3b8 into pelican:mainDec 28, 2025
5 checks passed
@coderabbitaicoderabbitaiBot mentioned this pull request Mar 17, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rowebil@rmartinoscar@notAreYouScared