Robyn icon indicating copy to clipboard operation
Robyn copied to clipboard

[Feature Request] Build more on the changed documentation

Open sansyrox opened this issue 3 years ago • 1 comments

Current Behavior

New documentation is more verbose than before. But it requires more work.

Desired Behavior

  • Add the latest performance comparison.
  • Document the public-facing API
  • Document Usage examples
  • Fix any grammatical error.
  • Hosting
  • .....

Screenshots / Mockups

Alternatives


sansyrox avatar Aug 29 '22 03:08 sansyrox

Feedback from Reddit


I like the look and feel of the documentation, but the navigation link is at the bottom on my android with firefox. It confused me for a minute. I'm used to those being near the top.

In the features page, in the first two examples, the handler doesnt take any arguments whereas the rest of the examples on that page take a request argument. There is no mention of this outside the code examples. Does a handler behave differently based on call signature? (The example on the getting-started page also takes no argments)

Side note: Im really digging the idea of a rust based framework for Python web apps.

I also like the const feature, and Im really looking forward to the orm integration mentioned in the roadmap. I would love to see some built-in authentication features as this is what keeps me chained to django (although I do really like django).

I would expect that in "Contributor Guidelines" there would be a link to https://github.com/sansyrox/robyn/blob/main/CONTRIBUTING.md. Besides that, all looks OK. The navigation is a little bit confusing, the links don't put you to the top of the page (at least in Firefox on desktop)

You have a section called Contribution Guidelines, but it is not a link to your contribution.md that you have on your Git repo. It would be good that you have a link to Our contrib guide on your repo.

sansyrox avatar Sep 03 '22 01:09 sansyrox