DioxusLabs / DioxusLabs/docsite

Consolidate reference documentation

Open
#513 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Rust
Stars
206
Forks
208
Avg merge
1h 11m
Merged PRs (30d)
3

Description

The documentation under the reference heading is generally more out of date and less detailed than what we have in the inline docs on docs.rs. For the documentation that covers a specific higher level concept, like the rules of hooks, we should move it into the essentials or guides section. For documentation that covers a specific hook like `use_coroutine` we should remove the page and point people to the docs.rs reference instead

We could also embed the docs.rs documentation into a subdomain on our docsite like [web-sys](https://rustwasm.github.io/wasm-bindgen/api/web_sys/) does. Our search indexing should be compatible with any html file so we could make the docs.rs reference pages show up in the guide search results as needed

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.