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

Suggestion on re-arranging the docs #262

Merged
merged 7 commits into from
Dec 17, 2024

Conversation

namelessvoid
Copy link
Contributor

This PR is a suggestion for #259 .

Updates to the structure:

  • The "Getting Started" section contains installation instructions for GDExtension version, module version and on C#.
  • The "Behavior Trees" and "Hierarchical State Machines" sections contain their respective docs.
  • The "Important classes" page was moved to the top of the "Class Reference" section.

I did not remove any info (just moved it - if something is missing, this was unintentional). I added some lines on HSMs on the index page and also added some "filler" text.

The proposed structure looks like this:

image

@namelessvoid
Copy link
Contributor Author

Note: I did not update the Readme file yet. If you like my proposal, I can update the Readme, too 🙂

@limbonaut
Copy link
Owner

There's also "Contributing" page missing that was added recently. You may want to rebase your branch to see it.

@namelessvoid
Copy link
Contributor Author

There's also "Contributing" page missing that was added recently. You may want to rebase your branch to see it.

True! I did rebase yesterday, but forgot to update the screenshot. The Contributing page is located in the "Getting Started" section.

@limbonaut
Copy link
Owner

Looks good! I just have a few suggestions before we merge it.

@namelessvoid
Copy link
Contributor Author

I like your suggestions and applied them! The Links in the Readme are now updated as well.

@limbonaut
Copy link
Owner

Thanks

@limbonaut limbonaut merged commit 6fecc1e into limbonaut:master Dec 17, 2024
@limbonaut limbonaut added the documentation Improvements or additions to documentation label Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants