godotengine
Add "Build System" section to godot-cpp docs.
This article is meant as a jump-off point for new godot-cpp users to understand how to build their GDExtension, and how to work with the binaries. Since much of the functionality is covered elsewhere, it is mainly some simple commands and explanations, and otherwise a hub of links for people to find the appropriate other spots.
Tagging @Enetheru, I can't request review from you through GitHub but I'd like to hear your opinion as well :)
you asked.. so.. I was confused as to the point of the document, it wasnt clear intially what the purpose of separating out the build system was to me and then the content of the document. I spent a few minutes looking at the existing latest documents and it makes even less sense why buildsystem should be singled out.
Starting with what we have already:
- about godot-cpp - details a little about the structure and differences of godot-cpp vs modules
- getting started - short tutorial / quickstart
- adding documentation. - more tutorial now specific to docs.
I would think that the buildsystem information belongs in the about section, and should not include any instruction, just links to the getting-started, or to a more detailed document.
and as a side note, the adding documentaion should be rolled into getting started, or at least have a chapter in there, and be stripped of any duplicate information like the bbcode tags, instead link to the appropriate section for that.
If there were going to be additional documents, they should be highly specific to a singular topic that can either be referenced from the about or quick start.
Is there some planning issue or document I could review to get my bearings on requests for review?
you asked.. so.. I was confused as to the point of the document, it wasnt clear intially what the purpose of separating out the build system was to me and then the content of the document. I spent a few minutes looking at the existing latest documents and it makes even less sense why buildsystem should be singled out.
Starting with what we have already:
- about godot-cpp - details a little about the structure and differences of godot-cpp vs modules
- getting started - short tutorial / quickstart
- adding documentation. - more tutorial now specific to docs.
I would think that the buildsystem information belongs in the about section, and should not include any instruction, just links to the getting-started, or to a more detailed document.
and as a side note, the adding documentaion should be rolled into getting started, or at least have a chapter in there, and be stripped of any duplicate information like the bbcode tags, instead link to the appropriate section for that.
If there were going to be additional documents, they should be highly specific to a singular topic that can either be referenced from the about or quick start.
Thanks for offering your opinion, I was hoping for something opinionated so I'm glad I asked 😄
This is how I envision the godot-cpp section to look like once everything is done:
- About godot-cpp: Explains what godot-cpp is, and how it connects to Godot. It does not contain any technical information.
- Getting started: What users click on initially when they make their very first godot-cpp project. It gets you up to speed as fast as possible, and does not explain any detailed concepts.
- Build system: Contains more detailed information about how to build godot-cpp. Since most of this is explained elsewhere, it ends up being mostly a link hub and collection of useful commands.
- ... other topics: More specialized articles on commonly needed features, e.g. how to bind methods, how to receive notifications, etc.
Perhaps you'd be interested in making a counter-proposal to this one? ^ This would definitely be interesting to discuss in the next GDExtension meeting as well!
I would think that the buildsystem information belongs in the about section, and should not include any instruction, just links to the getting-started, or to a more detailed document.
That makes sense. I agree on that.
and as a side note, the adding documentaion should be rolled into getting started, or at least have a chapter in there, and be stripped of any duplicate information like the bbcode tags, instead link to the appropriate section for that.
Hard disagree on that. Getting started would mean getting some first result like the typical print("Hello World") in every programming language. It should not contain more detailed information. We have to be careful not to add to much information in there. Also, the BBCode tags are purposely integrated since not every BBCode tag from the original page is supported. I tried them out.
If there were going to be additional documents, they should be highly specific to a singular topic that can either be referenced from the about or quick start.
That would be a good topic to discuss at the next meeting.
Hard disagree on that. Getting started would mean getting some first result like the typical print("Hello World") in every programming language. It should not contain more detailed information. We have to be careful not to add to much information in there. Also, the BBCode tags are purposely integrated since not every BBCode tag from the original page is supported. I tried them out.
Well perhaps I was overzealous on the topic, even if the documentation has its own page, it should have a mention in the getting started, even if its a link at the bottom section under next-steps.
Is there a reason this is only for 4.5 and that this does not apply to 4.4 and earlier?
Is there a reason this is only for 4.5 and that this does not apply to 4.4 and earlier?
Yes, the restructuring (https://github.com/godotengine/godot-docs/pull/10631) of these sections was only merged for 4.5, so it's somewhat difficult to merge back changes. Contents wise, it is absolutely applicable to 4.4 backwards.
