Add documentation summarizing the world generation algorithm
Rather than writing documentation in order, my plan is to prioritize what I believe to be the least-well-understood parts of Hypermine that I am familiar with. I also plan to write it in Markdown with TODO placeholders for images, as I believe that this would be the most efficient way for me to write the most essential parts of the documentation with the fewest distractions.
If/when it's time to add visualizations, I (or whoever adds them) should hopefully be able to focus entirely on the "how" rather than the "what".
As this documentation is meant to be understandable, please let me know if any parts of it are confusing, and I can try to reword it (or if it is fundamentally difficult to understand, I can try to make sure that there are enough placeholder images).
It looks like checks are still needed for this PR to be merged. I did find https://github.com/orgs/community/discussions/129235 after some googling, which seems related. I had forgotten that, while workflows are defined in the .github folder, it seems like which checks are required is defined elsewhere, in the repository settings themselves, which I lack access to (and, for safety reasons, I'd prefer to keep it that way).
Please let me know if you have any thoughts. It seems like one option could be to make these jobs a no-op if only the docs folder was modified, but having the checks be skipped entirely seems simpler.
The required checks should be in the repository settings, which you should have access to. Disabling that would be a fine expediency, IMO.
The required checks should be in the repository settings, which you should have access to. Disabling that would be a fine expediency, IMO.
For some reason, when I go to https://github.com/Ralith/hypermine/settings, I just get a 404. I believe it might be because I'm a "contributor" and not an "owner".
Thank you for the feedback! I will work on updating the wording based on all your suggestions.
I've dropped the check requirements for now, though it will likely take a push to refresh things.
It looks like I was able to merge it without an additional push. Thanks for the review!