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

The current organization of structs in the repository's cheatsheet could be improved to enhance readability and navigation. It would be beneficial to introduce submenus for structs and reorganize them accordingly. #1

Open
7etsuo opened this issue May 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@7etsuo
Copy link
Owner

7etsuo commented May 15, 2023

Proposed Solution

  • Implement submenus for the structs in the table of contents to create a hierarchical structure.
  • Rearrange the structs within their submenus based on logical grouping or categories.
  • Update the internal links in the table of contents and ensure they point to the correct locations within the document.

Expected Benefits

  • Improved readability and clarity by organizing the structs into submenus.
  • Enhanced navigation within the document.
  • Simplified access to specific struct categories.

Additional Context

Please look at the current version of the cheatsheet for the list of structs and their current organization. This enhancement would greatly benefit developers who frequently use the API and rely on the cheatsheet as a quick reference.

Contributions and suggestions are welcome! Please discuss this and propose your ideas for the struct organization and submenu structure.

@7etsuo 7etsuo added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels May 15, 2023
@7etsuo 7etsuo pinned this issue May 15, 2023
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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant