Skip to content

Conversation

@felinusfish
Copy link

@felinusfish felinusfish commented Oct 30, 2025

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
Copy link

netlify bot commented Oct 30, 2025

Deploy Preview for pelica ready!

Name Link
🔨 Latest commit ac6ed4c
🔍 Latest deploy log https://app.netlify.com/projects/pelica/deploys/6902c964ceb584000887fb8b
😎 Deploy Preview https://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

coderabbitai bot commented Oct 30, 2025

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

gOOvER commented Oct 30, 2025

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

@felinusfish
Copy link
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 !

@Boy132 Boy132 linked an issue Dec 1, 2025 that may be closed by this pull request
Sign up for free to 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