Version/Branch of Dear ImGui:

Version 1.92, Branch: Docking

Back-ends:

Not relevant

Compiler, OS:

Not relevant

Full config/build information:

Not relevant

Details:

Hello there.

First of all, I know writing documentation and update notes is a lot of work. I've written countless documentation pages for systems and code repositories, so I know that this can take aaaages and is absolutely not the most fun part about being a programmer.

Second of all, I'm not necessarily asking @ocornut to do this, but rather generally asking into the round of readers (that includes myself, of course).

And last, I'm aware that Dear ImGui was never strong on the documentation side and requires users to read through the code. I'm not asking for that to suddenly change.

--

Now, with that out of the way, I'm a bit overwhelmed by the 1.92 Update Notes and the different *.md files (such as FONTS.md and BACKENDS.md).

I don't want to dissect all files now, so here is just one example of one file, which caused me to open this issue:

FONTS.md has the following (partial) lines:

• Line 48: **Since 1.92, with an up to date backend: specifying glyph ranges is unnecessary.**
• Line 77; Specifying glyph ranges is not needed anymore.
• Line 145: **Since 1.92, with an up to date backend: specifying glyph ranges is unnecessary.**
• Line 173: **Since 1.92, with an up to date backend: specifying glyph ranges is unnecessary. All the GetGlyphRangesXXX() functions are marked obsolete.**
• Line 266: **Since 1.92, with an up to date backend: specifying glyph ranges is unnecessary. You can omit this parameter.**

So far, all of them state that "specifying glyph ranges is unnecessary". That's great, but then I get to the section of Using Custom Glyph Ranges and I encounter this line:

• Line 390: **Since 1.92, with an up to date backend: specifying glyph ranges is necessary, so this is not needed.**

Here it suddenly says that it's necessary.

Tiny mistake, of course, nothing to really get hung up on, but this can easily lead to a lot of confusion.
There are more places where the wording is unclear, has typos, or the structure across the file is not "helpful", making a user jump around between different sections of the file.

Now, again, I know the philosophy behind documentation for Dear ImGui, and I know there is barely enough time to even code on it, but if those files are being written to help, then it would be awesome if we could run them through some proofreading in whatever shape or form is appropriate. Even if it's just a PR that is announced so a few more peeps can have their eyes on the changes.

--

Finally, I just want to make sure that it's clear that this is mainly a suggestion. I'm aware that this suggestion should also mean that I can do this myself instead of asking others to spend their time on it. If no one has the time to do this, then that's also fine, this ain't a request after all. I hope no one takes this the wrong way.

Thanks for all the hard work on Dear ImGui and around it!

Screenshots/Video:

No response

Minimal, Complete and Verifiable Example code:

No response