Skip to content

Conversation

rubenwardy
Copy link
Contributor

@rubenwardy rubenwardy commented May 26, 2025

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

@wsor4035
Copy link
Collaborator

yeah, i dont agree with this at all

@rubenwardy
Copy link
Contributor Author

rubenwardy commented May 26, 2025

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

@wsor4035
Copy link
Collaborator

Please see the conversation in 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

@rubenwardy
Copy link
Contributor Author

rubenwardy commented May 31, 2025

Please can you comment in that issue so that we can come to a decision on where to place compilation instructions

Copy link
Contributor

@mark-wiemer mark-wiemer left a 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

@rubenwardy
Copy link
Contributor Author

Definitely in favor of keeping compile instructions in the repo, the repo should have everything someone needs to get started with code (compiling and running a working version). Stuff like debugging and beyond can be in a separate repo in my view, but no strong feelings there.

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?

@mark-wiemer
Copy link
Contributor

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)

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.

3 participants