Skip to content
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

Closed
wants to merge 67 commits into from
Closed

Documentation refactoring #13503

wants to merge 67 commits into from

Conversation

Bituvo
Copy link
Contributor

@Bituvo Bituvo commented May 13, 2023

Ready for review (and possibly becoming a 5.9 milestone)!

This PR adds these things to the documentation:

  • Modern primary and secondary headings
  • Capitalized headers
  • Slightly less whitespace before primary headers
  • Github flavored warnings and information boxes
  • Lua code blocks where appropriate
  • Tables where appropriate
  • Inline code blocks where appropriate
  • Removal of extra whitespace in tables ({ min=3, max=5 } -> {min=3, max=5})
  • Typo fixes (especially id instead of ID)
  • Removed table of contents from /README.md as Github has a builtin one

To do (preferably in a different PR, just putting it out there):

  • Use a consistent maximum line width (maybe increasing with each level of bullet points)
  • Scour for typos and other mistakes
  • Redo 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.

@appgurueu
Copy link
Contributor

Regarding the table of contents (ToC), the same as for the other PR applies:

I feel like such a table of contents is (1) redundant and (2) probably will eventually be out-of-sync with the document. I think generating a ToC is the job of Markdown renderers.

And as ruben pointed out, "GitHub shows a table of contents in the top left."

doc/android.md Outdated Show resolved Hide resolved
@Bituvo Bituvo requested a review from appgurueu May 14, 2023 16:34
Copy link
Contributor

@AFCMS AFCMS left a 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

@Bituvo
Copy link
Contributor Author

Bituvo commented May 22, 2023

If that wasn't done already, I would have done that in this PR :)

@rubenwardy rubenwardy added the Maintenance Tasks to keep the codebase and related parts in order, including architectural improvements label May 27, 2023
Copy link
Contributor Author

@Bituvo Bituvo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/texture_packs.md Outdated Show resolved Hide resolved
doc/texture_packs.md Outdated Show resolved Hide resolved
doc/texture_packs.md Outdated Show resolved Hide resolved
doc/texture_packs.md Outdated Show resolved Hide resolved
doc/texture_packs.md Outdated Show resolved Hide resolved
@rollerozxa
Copy link
Member

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?)

README.md Outdated Show resolved Hide resolved
doc/lua_api.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
This was referenced Nov 21, 2023
@Zughy Zughy added the Rebase needed The PR needs to be rebased by its author. label Jan 15, 2024
@Zughy
Copy link
Member

Zughy commented Jan 15, 2024

@Bituvo rebase needed

@Zughy
Copy link
Member

Zughy commented Jan 15, 2024

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 Zughy closed this Jan 16, 2024
@Bituvo Bituvo deleted the doc_refactor branch January 20, 2024 13:42
@Bituvo
Copy link
Contributor Author

Bituvo commented Jan 20, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@ Documentation Maintenance Tasks to keep the codebase and related parts in order, including architectural improvements Possible close Rebase needed The PR needs to be rebased by its author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants