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

Point user to further reading at end of GDExtension example #9403

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TvdSmagt
Copy link

Based on a discussion I had here, I thought it would be best to point the reader of the GDExtension C++ example to the location of other existing C++ documentation.

For someone that is new to the documentation, it might not make sense to look for explanation of the core types in the "Contributing" section. This is something that I myself ran into.

@paddy-exe
Copy link
Contributor

paddy-exe commented May 20, 2024

I don't think it's a good idea to have this at the end of this page. To be honest I think even the icons section is unnecessary and should be in a separate page. There's way more pages that could be added here and just having a list of all of them at the end looks more like this is going to be the only docs page for GDExtension. I am already working on more pages that go into details of the system and I would rather have a dedicated "additional resources/docs" section where these pages are linked.

@TvdSmagt
Copy link
Author

Fair point. I just wanted to make sure that the reader is also pointed to that section in the documentation, as it being listed under "Contributing" is not an intuitive place to look IMO.

If I can help you in any way with these pages you are creating, or if you want me to put this in a separate page with "additional resources/docs", let me know.

@paddy-exe
Copy link
Contributor

Fair point. I just wanted to make sure that the reader is also pointed to that section in the documentation, as it being listed under "Contributing" is not an intuitive place to look IMO.

If I can help you in any way with these pages you are creating, or if you want me to put this in a separate page with "additional resources/docs", let me know.

Yeah absolutely understandable and I generally fully agree that this information should be linked in the GDExtension docs. Thank you first and foremost for creating this PR in the first place. I think having a separate page called "Additional resources" would be imho great but this should be probably be talked about in the engine developer chat. Would be great to have more people working on these pages so thank you already in advance!

@paddy-exe paddy-exe added the area:manual Issues and PRs related to the Manual/Tutorials section of the documentation label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants