Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER
, '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" + '
Documentation Full Rewrite (Standalone -> Docker) by felinusfish · Pull Request #172 · pelican/docs · GitHub
Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER
, '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('^' + ".*" + ' Documentation Full Rewrite (Standalone -> Docker) by felinusfish · Pull Request #172 · pelican/docs · GitHub
Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER
, '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('^' + ".*" + ' Documentation Full Rewrite (Standalone -> Docker) by felinusfish · Pull Request #172 · pelican/docs · GitHub
Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER
, '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" + ' Documentation Full Rewrite (Standalone -> Docker) by felinusfish · Pull Request #172 · pelican/docs · GitHub
Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER
, '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('^' + ".*" + ' Documentation Full Rewrite (Standalone -> Docker) by felinusfish · Pull Request #172 · pelican/docs · GitHub
Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER
, '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); } })(); })(); Documentation Full Rewrite (Standalone -> Docker) by felinusfish · Pull Request #172 · pelican/docs · GitHub
Skip to content

Documentation Full Rewrite (Standalone -> Docker) - #172

Draft
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite
Draft

Documentation Full Rewrite (Standalone -> Docker)#172
felinusfish wants to merge 8 commits into
pelican:mainfrom
felinusfish:docs-rewrite

Conversation

@felinusfish

@felinusfishfelinusfish commented Oct 30, 2025

Copy link
Copy Markdown

A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.

The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.

There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.

CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).

@netlify

netlifyBot commented Oct 30, 2025

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commitac6ed4c
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Previewhttps://deploy-preview-172--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

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@gOOvER

Copy link
Copy Markdown

idk, If this is really needed, since Proxys official Not supported

@felinusfish

Copy link
Copy Markdown
Author

idk, If this is really needed, since Proxys official Not supported

Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them !

@Boy132Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
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.

Guide for creating eggs & images

2 participants

@felinusfish@gOOvER