seed-rs / seed-rs.org Goto Github PK

Hi!

We want to make Seed's website and documentation as good as possible.

We've recently created a new website (this repository + seed-rs.org). We resolved the main pain points with it - it's responsive, prerendered for the fast first render and better SEO, there is a simple search, night mode, etc. But we think that it's still not good enough.

Could you help us to make Seed's website better?

I think we should focus on the content as the first step to better website.

• We can divide website content into two parts:

  1. Homepage / Landing page - the first page that a (new) Seed user see:

     • Is it clear what Seed is on the first glance?
     • Do you think that something is missing?
     • Or something should be removed?
     • Is it beginner-friendly?
     • Is it good enough for Seed's "marketing"? - Are there enough examples, social proofs, comparing with other frameworks / langs / technologies, etc.?
     • etc.

  2. Documentation - tutorials, guides, changelog, etc.

     • Do you think that something is missing?
     • Are code examples good enough? (too simple? too complex? too few comments?, ..)
     • Is it beginner-friendly?
     • Are there any unnecessary sections?
     • Did you find a typo?
     • Are any parts hard to read or understand?
     • Did you find out-of-date info or dead links?
     • etc.

Thank you!

https://seed-rs.org/ shows blue panel while loading.
Context: #52 (comment)

I am updating the code so that I can fix the seed-rs/seed#364 .

Chat - #documentation

Tock: just started working through the new docs. Am on App 1: Counter / Init. You just got done on the previous page talking about how you shouldn't implement Default for Model, then the first thing on this page I see is Model::default(). Now I know it's because it's an int alias, so we're getting i32::default(), but as someone who might have missed that, it's jarring. Maybe just have the init() return 0 directly?

MartinKavik: I was fighting with myself whether there should be:
A) Model::default()
B) 0
C) Change Model to something like:
struct Model {
click_count: u32
}
because a type alias as Model is an edge-case.
So perhaps we should change it to 0. Do we want to change it also in README and /examples/counter?
Also it doesn't break the rule that we shouldn't implement Default for Model - it has been already implemented by Rust std..

    orders.subscribe(|_: subs::UrlChanged| log!("url changed!"));

missing |

Options:

• Inline code from validated files during markdown -> html compilation - see build.rs.
• Embed code snippets from service like Rust playground that supports Seed.

Front page under "note on view syntax" it says
The lack of resemblance to HTML be offputting,
I think this should read
The lack of resemblance to HTML may be offputting,
Also the "why add another?" section
it uses Rust builtin types, with thinly-wrapped by macros
makes more sense without the "with"
it uses Rust builtin types, thinly wrapped by macros

• Yasmi (chat, documentation channel)

One thing that could help is to compile a FAQ that works like this website: http://microjs.com/ i.e. there is a list of the things that people commonly ask how to do them, and then, as an answer, the site shows one small paragraph that explains, and a link to the corresponding example. So, there would be "I need to..." and a choice box. One choice: "redirect to another URL". Answer: "The Seed way to work with the browser URL is to use the URL subscription API (link). All you have to do to redirect to another page is to notify the UrlRequested subscription like this: orders.notify(subs::UrlRequested::new(url))".

@sabine - seed-rs/seed#433 (comment)

I have the same problem here as seed-rs/seed-quickstart#37.

The issue resolved after I did cargo update.

"Unexpected node type found from raw html"

We should add a dead-link linter to the build / deploy pipeline.

Dead-link example: https://docs.rs/seed/0.5.1/seed/fetch/struct.Request.html on https://seed-rs.org/guide/http-requests-and-state.
It should be replaced with https://docs.rs/seed/latest/seed/browser/service/fetch/index.html

• 0.5.1 => latest (if we want to point always to the latest version)
• fixed path

When I expand an Example code section and change to the next topic/page, the next example is still expanded and contains the prior content. It needs a page reload to fix that.

Is this related to prerendering or just a plain bug ?

theres a bit of a wrinkle on todo app doc, view page, section 11. you show the changed view() and view_filters(), but not the changed view_footer(). Section 12 then immediately changes view_footer again, so it sorts itself out, but in theory I can't get the code to compile between sections 11 and 12 (without knowing what I'm doing and fixing view_footer() ).

People want to decide whether to use Seed or Yew. We should add detailed comparison on the website.

Live (very rough) draft content below:

Hi, Is there a comparative between Yew and Seed?
hi @reymon#5 @cascalheira#5661 - I think there isn't updated comparison and there are probably guys with more current Yew knowledge, but in a few points:

• I moved to Seed from Yew because there was missing docs and things like router, fetch library, sync with animation frame, etc. And I was fighting with JSX syntax + things like actors and other experiments feel unnecessary. (it was some time ago, I don't know current status really)
• It's the perfect time to start with Seed - we are releasing new version - seed-rs/seed#436 - I'll update quickstarts and rewrite docs so I hope it will be better than Yew's one.
• I don't know about Yew, but I use Seed to develop apps for clients as freelancer - we have direct feedback from real-world use-cases.
• Typed abstraction for CSS is WIP.
• Seed app architecture is more Elmish, but something like React Hooks are in development (also Seed's Hooks will have far less limitations than React's one). I think Yew also experimenting with hooks, but there are the same React's limitations. Also Yew is more component-oriented now (= has strict interface for components).
• Seed has examples with patterns for writing big Rust apps (nested routing, link building, base urls, graphql, etc.).
• Seed has webpack-quickstart for writing and deploying prerendered production-ready app with tutorial in README. There will be also Rust-only alternative to Webpack alternative - https://github.com/MartinKavik/seeder
• Yew has switched to wasm-pack recently, Seed uses it from start.
• According to benchmarks - Seed is faster.
• "Trying to decide between the framework with a lot of stars on github and the framework that looks like the better idea :)"
  Yew was the first one (year before Seed I think) and there are some articles about it. We'll write more Seed guides / tutorials / articles and redesign webiste in next months to improve "marketing".
• Seed vs Yew downloads - 47k vs 32k.

Is somebody (who ideally knows Yew) willing to write a proper comparison 🙏?

The first item we implement is toggle todo, then remove todo. But we don't actually get to create todo until step 4. I suggest moving steps 3 (new todo title updated) and 4 (create todo) up to the top so that when we get to the toggle and remove, I can immediately see them have an effect.

Either that or earlier on in the tutorial, have the default model start with some pre-existing todos. (see also #60 )

step 1 changes update for RemoveTodo but view for ToggleTodo. Step 2 does the opposite.

Originally opened at seed-rs/seed#609

The logo in the header is really large. It's noticeable on desktop but particularly stands out on mobile.

It also covers the second logo on the narrow viewport (see screenshot below). My suggestion is to make the logo of a similar size as the the button links.

Originally opened at seed-rs/seed#610

During scrolling in dark mode, the white background is visible at the bottom. Once the scroll stops, it disappears. It's like a flicker during scroll only.

Its only at the top part of the page. Scrolling down more doesn't show any white.

On both Google Chrome and Firefox on Android.

Screenshot captured during scroll with finger on the screen

Hi!

On your website you link to a forum with https://seed.discourse.group/ as link. That link does not resolve for me.

There seems to be a bug with the sizing of the logo on google chrome:

Google Chrome vs Firefox:

The result of this error can be seen in this image.

This happens on chromium-based browsers, since it will not interpret viewbox as viewBox (like in Firefox). This case-sensitive behavior is unique to the <svg> tag, and is necessary for proper rendering.

After checking the rust code for the site (and seed itself) I can conclude that the issue doesn't lie in the rust code or the svg files for the seed logo. I suspect it is the result of a postprocessing step minifying the code. It could be similar to this problem with Parcel where it would lowercase the viewBox attribute. I'm unsure at the moment what JS dependency of the site could be causing this behavior.

Add link to Discord chat:

• Homepage
• Seed's readme

Code is trying to show filter getting into view_main, but shows view_footer instead:

fn view(model: &Model) -> Vec<Node<Msg>> {
    ...
            view_footer(&model.todos, model.filter),
...

fn view_main(todos: &BTreeMap<Ulid, Todo>, selected_todo: Option<&SelectedTodo>, filter: Filter) -> Node<Msg> {
    ...
        view_todo_list(todos, selected_todo, filter),
...

(I'll probably fix up these issues when I get to the end of the tutorial)

Hello,
May we get feature that allow us to press key to navigate the tutorial webpage? Its will be useful to navigate the page

Looks like a typo in the View guide: https://seed-rs.org/guide/view

input![ attrs!{At::Typed => "checkbox"; At::Checked => true.as_at_value()} ]

Should be At::Type, right?

Also underneath that is At::Autofocus, but it should be At::AutoFocus

@samueller

The current documentation refers to calling mount() which generates compile errors with 0.6.0. The new way is to call mount_point() from before_mount.

the screenshot at the end of https://seed-rs.org/0.7.0/todomvc_view has todo items in it, but we haven't written the event handler code yet, nor have we edited the default Model state to include todos, so my version can't possibly look like that one.

And https://downforeveryoneorjustme.com/seed-rs.org?proto=https agrees, so probably not just a local issue of mine.

If seed.org is open in a browser with JavaScript disabled or without WebAssembly support, then searching and switching the color scheme does not work quietly. We should display a warning that the browser does not support WebAssembly.

The website is really good! Thanks!
The only small problem is that if you switch to dark mode and refresh the page, it first renders in light mode, then switches.

Originally posted by @tiberiusferreira in seed-rs/seed#303 (comment)

The forum site listed in https://seed-rs.org is down.

Details - seed-rs/seed#325
PR - seed-rs/seed#328