docsite icon indicating copy to clipboard operation
docsite copied to clipboard

Integrate Dioxus Docs Into Docsite

Open mcmah309 opened this issue 1 year ago • 2 comments

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 https://github.com/DioxusLabs/docsite/issues/436

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

mcmah309 avatar Feb 20 '25 14:02 mcmah309

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 avatar Feb 20 '25 22:02 ealmloff

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).

nicoburns avatar Mar 03 '25 19:03 nicoburns