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

Integrate Dioxus Docs Into Docsite #448

Open
mcmah309 opened this issue Feb 20, 2025 · 2 comments
Open

Integrate Dioxus Docs Into Docsite #448

mcmah309 opened this issue Feb 20, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mcmah309
Copy link

mcmah309 commented Feb 20, 2025

A lot of useful information can be found in https://github.com/DioxusLabs/dioxus/tree/main/packages

First at the <package_name>/README level and secondly at <package_name>/docs/*. I would be worth while if this could be integrated into the docsite and made searchable.

Do do so, I propose that https://github.com/DioxusLabs/dioxus/ become a submodule of this repo and a new section crates be added to the docs

Crates
├── ...
├── document
│   ├── head
│   ├── eval
├── ...

This proposal is related to the third bullet here #436

If this proposal and implementation is accepted. I'd be happy to work on it.

@ealmloff
Copy link
Member

Some crates like web-sys host their API docs outside of docs.rs. We could do the same for dioxus under a /api-docs route and include the results in the search index. The <package_name>/docs/ folders of the dioxus crates only contain some of the api docs, and they are often not useful on their own. For example, the rules of hooks documentation is added to every hook function's api docs

@ealmloff ealmloff added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 20, 2025
@nicoburns
Copy link
Contributor

Specifically the information from the READMEs that explains what the package is would be useful as part of /learn on the docsite I think. Might help us remember to keep it updated too as I think some of those READMEs are quite out of date (or were last time I checked).

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
Projects
None yet
Development

No branches or pull requests

3 participants