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

Suggested Docs Improvements #436

Closed
mcmah309 opened this issue Feb 7, 2025 · 3 comments
Closed

Suggested Docs Improvements #436

mcmah309 opened this issue Feb 7, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@mcmah309
Copy link

mcmah309 commented Feb 7, 2025

I start learning Dioxus a few days ago and here are some suggestions that would make the docsite better for new users.

  • Use latest in addition to version number. Currently the learn link uses the latest version number https://dioxuslabs.com/learn/0.6 . The problem with this is that search engines like google don't really understand that versions like 0.5 are obsolete until more users start using the 0.6 docs and enough time has past. Therefore a lot of google searches for questions lead to old documentation like 0.5 or 0.4. If something like latest was also used, overtime as these pages are used more frequently, they will be served more. Plus users can then create bookmarks to the current docs.
  • The search bar in https://dioxuslabs.com/learn/0.6 is pretty much useless and without it users need to guess where the appropriate content may be. This is should be improved.
  • A lot of the documentation can be found in https://docs.rs/dioxus/latest/dioxus/index.html . It would be nice if this was somehow integrated into https://dioxuslabs.com/learn or a made more prevalent since I was unaware of this as a resource at the beginning. This might be a good opportunity to highlight and expand upon https://dioxuslabs.com/learn/0.6/contributing/project_structure# . Maybe even moving some of the concepts higher up in the learn path. I watched the talk for GOSIM 2024 and found it fascinating. This might be a good opportunity for releasing an LLM agent also trained on the documentation or just integrate something like meilisearch into the docs.
@ealmloff ealmloff added the documentation Improvements or additions to documentation label Feb 13, 2025
@ealmloff
Copy link
Member

Use latest in addition to version number. Currently the learn link uses the latest version number https://dioxuslabs.com/learn/0.6 . The problem with this is that search engines like google don't really understand that versions like 0.5 are obsolete until more users start using the 0.6 docs and enough time has past. Therefore a lot of google searches for questions lead to old documentation like 0.5 or 0.4. If something like latest was also used, overtime as these pages are used more frequently, they will be served more. Plus users can then create bookmarks to the current docs.

Yes, I would like to support a latest form of the URL like docs.rs. We have also added noindex to the old documentation to remove it from search results, but that takes some time to apply

The search bar in https://dioxuslabs.com/learn/0.6 is pretty much useless and without it users need to guess where the appropriate content may be. This is should be improved.

The search bar was fixed in #443

@mcmah309
Copy link
Author

mcmah309 commented Feb 20, 2025

The first part of bullet three could be addressed by #448

The second part of bullet three was moved to its own issue DioxusLabs/dioxus#3772

@mcmah309
Copy link
Author

Created #449 to cover the first bullet.

Second is fixed. Thus closing.

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

No branches or pull requests

2 participants