Skip to content

Readme.md - community feedback #302

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

Closed
MartinKavik opened this issue Dec 3, 2019 · 3 comments
Closed

Readme.md - community feedback #302

MartinKavik opened this issue Dec 3, 2019 · 3 comments
Labels
docs Missing examples, tutorials, guides, typos, .. help wanted Extra attention is needed

Comments

@MartinKavik
Copy link
Member

Hi!
We want to make Seed's documentation as good as possible.
Could you help us to make Readme.md better?

  • 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?
  • Are any parts ugly / not formatted or not styled enough?
  • Did you find out-of-date info or dead links?
  • etc.

Thank you!

@MartinKavik MartinKavik added the help wanted Extra attention is needed label Dec 3, 2019
@MartinKavik MartinKavik pinned this issue Dec 3, 2019
@MartinKavik MartinKavik unpinned this issue Dec 3, 2019
@MartinKavik
Copy link
Member Author

@hwchen's feedback (#111 (comment)):
I'm a backend dev exploring Rust front-end frameworks. Of course, one of the first things I tried to do was make a component :). But reading through this issue, and reading some of the Elm discussion links helped me understand the theory of this framework.

It would have be helpful to me if this "reusable views over nested components" was mentioned explicitly in the Readme. I think it's easy to understand the basic Elm architecture pretty easily, but understanding preferred patterns for more complex apps is not obvious. As it is, I had to search several issues for the answer.

@nielsle
Copy link

nielsle commented Feb 4, 2020

The readme is great. Here is a small nitpick. The "short example" does not tell the user to create a Makefile.toml and terefore cargo make serve did not work for me

[cargo-make] INFO - cargo make 0.26.2
[cargo-make] INFO - External file not found or is not a file, skipping.
[cargo-make] INFO - Project: test
[cargo-make] INFO - Build File: Makefile.toml
[cargo-make] INFO - Task: serve
[cargo-make] INFO - Profile: development
[cargo-make] ERROR - Task not found: serve
[cargo-make] WARN - Build Failed.

EDIT: I copied a Makefile.toml from seed-rs-realworld and wrote cargo make all to avoid
seed-rs/seed-rs-realworld#1 and now it works nicely.

@MartinKavik
Copy link
Member Author

@nielsle Thanks!
@David-OConnor Could you fix it once you have some time?

@MartinKavik MartinKavik added the docs Missing examples, tutorials, guides, typos, .. label Mar 9, 2020
peter-lyons-kehl added a commit to peter-lyons-kehl/seed that referenced this issue Nov 10, 2020
MartinKavik pushed a commit that referenced this issue Nov 11, 2020
@flosse flosse closed this as completed Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Missing examples, tutorials, guides, typos, .. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants