-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Documentation refactoring #13503
Documentation refactoring #13503
Conversation
Regarding the table of contents (ToC), the same as for the other PR applies:
And as ruben pointed out, "GitHub shows a table of contents in the top left." |
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.
This is something I really like.
I considered it when making #13439
If that wasn't done already, I would have done that in this PR :) |
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.
Self-review
There's quite a lot of noise in the PR caused by ". " being replaced with ". " in things such as code comments. (as well as translation files which I think shouldn't be touched?) |
@Bituvo rebase needed |
Actually, according to https://irc.minetest.net/minetest-dev/2024-01-15#i_6146082, I don't this PR will make it. If split into smaller PRs and if covering only relevant aspects (see Rollerozxa comment), I guess there won't be big issues though |
@Zughy I completely understand. A new PR has been opened, much cleaner and with less noise: #14287 |
Ready for review (and possibly becoming a 5.9 milestone)!
This PR adds these things to the documentation:
{ min=3, max=5 }
->{min=3, max=5}
)id
instead ofID
)/README.md
as Github has a builtin oneTo do (preferably in a different PR, just putting it out there):
protocol.txt
Some people still use the plaintext version of the Lua API, so I tried to maintain readability while still simplifying things.
The original PR for this was #13494, but it was messed up because I forgot to create a new branch.