Skip to content

Conversation

@tetrapod00
Copy link
Contributor

See #10369. Discuss and approve that PR first. As is, this PR implements the standard order of headers described in that PR:

Page title
==========

Header
------

Sub-header
~~~~~~~~~~

Sub-sub-header
^^^^^^^^^^^^^^

Sub-sub-sub-header
""""""""""""""""""

I think I found all the changes to make here, but I might have missed some pages. Since RST handles header syntax per-page, it's not a big deal to come back later and fix any pages that I mised. In each changed page here, I made sure to read through the whole page and confirm that the required changes have been made.

@tetrapod00 tetrapod00 added enhancement area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation area:engine details Issues and PRs related to the Engine Details section of the documentation area:community Issues and PRs related to the Community section of the documentation content:proofreading Issues and PRs related to proofreading the documentation labels Dec 5, 2024
Comment on lines +77 to +78
~~~~~~~~~~~~~~~~~~~~~~~~~~

Copy link
Contributor Author

@tetrapod00 tetrapod00 Dec 5, 2024

Choose a reason for hiding this comment

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

This is the one "real" change here, and the source of the +1 line. It adds a space between the header and a table.

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

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

I need to find time to review all of this but I'm ok with this standardization. @mhilbrunner any thoughts?

@tetrapod00
Copy link
Contributor Author

Note that even though there are no conflicts, this is no longer good to merge as-is without going through all the pages again, due to additions within the changed pages that still use the existing set of header syntax.

@mhilbrunner
Copy link
Member

@tetrapod00 I think this looks good and makes sense, feel free to rebase/fix and then go ahead and merge to avoid conflicts piling up again.

@tetrapod00 tetrapod00 force-pushed the standardize-header-the-rest branch from 331aa5a to db5ecf6 Compare December 29, 2024 21:39
@tetrapod00 tetrapod00 force-pushed the standardize-header-the-rest branch from db5ecf6 to c4d3aa1 Compare December 29, 2024 21:44
@tetrapod00
Copy link
Contributor Author

I looked through the already changed pages and found two fixes to make. Additionally, I looked through recently merged new pages and updated those as well.

Since I don't expect us to merge any more large pages during this slow period, I'll wait to merge this for just a little while in case @skyace65 or anyone else wants to take another look.

@mhilbrunner mhilbrunner merged commit 4b4e851 into godotengine:master Jan 2, 2025
1 check passed
@mhilbrunner
Copy link
Member

Lets start the new year by getting this in :) Thanks!

@tetrapod00 tetrapod00 deleted the standardize-header-the-rest branch January 2, 2025 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:community Issues and PRs related to the Community section of the documentation area:engine details Issues and PRs related to the Engine Details section of the documentation area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:proofreading Issues and PRs related to proofreading the documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants