Skip to content

Re-order sections of the About category #8399

@Cerno-b

Description

@Cerno-b

Your Godot version:

Head of the master branch of the godot-docs repo

Issue description:

I find the structure of the About section a bit odd.

First, I don't understand why the Troubleshooting section is featured so prominently, I think it gives a bad first impression, since it's:

  • Introduction (obviously)
  • FAQ, ok, a bit too soon, but why not?
  • Immediately a list of things that don't work as expected.

I think the Troubleshooting section (if needed in the docs at all), should be moved to the very bottom below Class Reference, or potentially even removed as there are other troubleshooting resources available. I assume its purpose is to collect certain very common problems that beginners have. Is it even up-to-date with the currently known frequent issues?

And then the rest of the sections are not in a very optimal order. In terms of what a new reader might expect or need, I would suggest the following order:

  • Intro
  • Feature List
  • FAQ (switch with Feature List because tell me what the engine can do before trying to answer questions I may not have yet)
  • Licenses (move it up because we need to talk about legal implications as soon as my questions are answered)
  • Release Policy
  • Changelog (put changelog last because it's some housekeeping info that I would kind of expect there)

And then, as outlined above, move the Troubleshooting stuff to the very bottom of the docs, if they are even needed in the docs after all.

URL to the documentation page (if already existing):

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:aboutIssues and PRs related to the About section of the documentation and other general articlesenhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions