Fix broken references to yew_services#1861
Conversation
Update the `use` statement in the Fetch example. Fix the broken links to Rust docs. Improve wording.
|
Visit the preview URL for this PR (updated for commit a2cdbe3): https://yew-rs--pr1861-master-jn2j27o8.web.app (expires Fri, 28 May 2021 19:25:37 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
This PR consists only of minor doc fixes in .md files. The failing check is not related. |
| ### [`ConsoleService`](https://docs.rs/yew/latest/yew/services/console/struct.ConsoleService.html) | ||
|
|
||
| This service is included within the [`yew-services`](https://crates.io/crates/yew-services) crate: | ||
| This service is included with Yew. |
There was a problem hiding this comment.
Possible improvement?
| This service is included with Yew. | |
| This service is defined inside the `yew` crate. |
| ## Source Maps | ||
|
|
||
| There is currently no first-class support for source maps for Rust / Wasm web apps. This, of course, is subject to change. If this is no longer true or if progress is made, please suggest a change! | ||
| There is currently no first-class support for source maps for Rust/Wasm web apps. This could change in the future. |
There was a problem hiding this comment.
Maybe?
| There is currently no first-class support for source maps for Rust/Wasm web apps. This could change in the future. | |
| Sadly Rust/Wasm web apps are not properly supported by browsers. Hopefully this will change in the future. |
| ```rust | ||
| use yew::format::Nothing; | ||
| use yew_services::fetch::Request; | ||
| use yew::services::fetch::Request; |
There was a problem hiding this comment.
These changes are wrong, since the layout was recently changed and the services are in a separate crate now: https://github.com/yewstack/yew/tree/master/packages/yew-services
Please note that you're editing the documentation for the 'master' branch which contains changes that haven't been published yet.
There was a problem hiding this comment.
I definitely missed that.
Shall I remove the yew_services changes and still add the wording changes here in master?
There was a problem hiding this comment.
Yeah, I think the wording changes are great!
|
See also #1728 |
|
It's worth mentioning that yew_services is going away as part of #1842. |
|
That is awkward. I think that these changes are still worth incorporating though, because much of this documentation will hopefully be repurposed alongside the bits that are moved into |
|
I agree. It's worth updating the documentation |
Co-authored-by: Teymour Aldridge <42674621+teymour-aldridge@users.noreply.github.com>
Co-authored-by: Teymour Aldridge <42674621+teymour-aldridge@users.noreply.github.com>
|
I made this PR because I was following the fetch example on 0.18.0 when I noticed the use declaration in the next docs was not working (it referred to yew_services crate). Just to double-check:
Cheers |
yew_services will be gone when #1842 lands.
The yew.rs website is maintained on the master branch for both 'next' and '0.18.0' docs; therefore, changes to documentation of 0.18.0 will be changed on On
Hope that helps answer the questions :) |
|
|
5 participants
Update the
usestatement in the Fetch example.Fix the broken links to Rust docs.
Improve wording.