-
Notifications
You must be signed in to change notification settings - Fork 27
Remove compiling guides, redirect to engine doc/compiling #233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
yeah, i dont agree with this at all |
Rather than downvoting, please see the conversation in and respond there luanti-org/luanti#16116 I don't mind where the compiling docs are, but we should not have multiple copies in different places |
yeah, i saw it |
Please can you comment in that issue so that we can come to a decision on where to place compilation instructions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Request to abandon this PR personally, my last comment in the original issue still stands
I interpreted this comment as meaning keep the compile instructions in the engine repo. Are you in favour of moving it to the docs repo instead? |
Personal opinion: Minimal compile instructions should stay in the engine repo for experienced folks to get started quickly without having to read through too much fluff. Troubleshooting and advanced compile instructions should live in the docs repo. Mainly because I believe it's much easier to merge a docs PR, and having docs on a website instead of just a "plaintext" Markdown file in a repo is a bit easier to reference. If we want docs to live in the engine repo, we should define a simple process where docs-only PRs don't have to pass code checks. Bonus points if we also publish engine-repo compile instructions in a more readable form (e.g. a website instead of just a Markdown file) |
Ideally, I could redirect each page to the corresponding doc/compiling file on GitHub, but I don't know how to do external redirects using Hugo
See luanti-org/luanti#16186