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
Improve grammar and paragraph structure in documentation #2620
Conversation
Visit the preview URL for this PR (updated for commit 96f36cb): https://yew-rs--pr2620-improve-docs-6bp4ze8q.web.app (expires Wed, 27 Apr 2022 08:25:08 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Size Comparison
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested the JetBrains templates and they all work fine.
I was a bit confused when it required a Default
trait property when rendered without explicit props, but I guess that's just a breaking behavior compared to 0.19? I didn't follow recent progress~
@Madoshakalaka You might be misremembering, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also
- Rename "Function Components" in sidebar to "Components"
- Rename "Intro With Basic Web Technologies" in sidebar to "Using Basic Web Technologies In Yew" combine "JavaScript with Rust" with it.
- Reorder the concepts in the order they should read in
- Remove
use_<hook>
page and instead use API docs for those. We shouldn't be documenting the API in the website1
Footnotes
-
I added them in Add docs for Hooks #1643. Maybe that wasn't the smartest move ever ↩
let combined_html: Html = html!{ | ||
<div>{header_html}{counter_html}</div> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let combined_html: Html = html!{ | |
<div>{header_html}{counter_html}</div> | |
let combined_html: Html = html! { | |
<div>{ header_html } { counter_html }</div> |
Just some formatting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added a space behind html!
but the other spaces might suggest spaces in the generated HTML, so I'd leave them out.
Co-authored-by: Muhammad Hamza <muhammadhamza1311@gmail.com>
5a978bd
to
525d9bd
Compare
I'll leave that for a future PR. I think it would be nice to have the rust docs for master linked here, instead of the rust docs for the most-recently deployed version. That's a bit more effort than I can spend right now. |
That's fine. I'll do that soon I'm going to merge it now. If any docs changes are wanted later, those can come in separate PRs |
Description
Fixes #2573 @Madoshakalaka maybe you can test the new JetBrains templates and review them
Fixes #2180, i.e. #2178 (comment) (the offending sentence has been removed from the docs. It shall never be seen again. I think I know what it was meant to document, but I'm not sure if that "feature" is intended behaviour at this point)
This also slightly changes the
keyed_list
example. According to my tests, it did not actually perf-test the time it took for individual renders to happen. This now reports the time it takes from an initialview -> rendered
of the wrapper class, which should be more reliable. To see that the current way is absurd, add a few thousand items to the live example and be surprised that it reports <100ms render times even as the browser visibly lags and stops to a crawl.Checklist
cargo make pr-flow