Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

[Docs]: most ANNOYING doc I've ever seen in a long time for such a mainstream lib #10461

Closed
lucasbordeau opened this issue May 8, 2023 · 1 comment
Labels

Comments

@lucasbordeau
Copy link

lucasbordeau commented May 8, 2023

Describe what's incorrect/missing in the documentation

Here is concise feedback on the current situation which is intolerable for this project size :

  • Feels convoluted and way too complex for the average use case of a BrowserRouter with a few routes.
  • No installation page in the getting started section, this is basics.
  • Have to go through a full tutorial to get started.
  • Examples are on a repository for the user to look, the simplest ones could be copy/pasted on the example page or have a stackblitz/codesandbox demo iframe.
  • Overall it feels like the documentation mixes small tips with general concepts in an unstructured way.
  • Why can't we have the v5 documentation back ? It was a great and original UI/UX experience !

Proposal :

  • Put an installation copiable component on the home page, above the 4 box section.
  • Add an installation page in the getting started section with a copiable section containing the line to install everything needed and other considerations.
  • Add a SIMPLE example page just below installation page, to cover 80% of most uses cases which should be how to install a very basic BrowserRouter in your React app the new way vs. the old way (or redirect to migrating from v5 for the old way).
  • Picking a router page : just put a table with two columns : Your situation | Recommended routers
  • Picking a router page : Put the DataAPI section and updates into a single coherent sub heading
  • Example section : add examples from the repository and explain for dummies. Keep advanced examples in another section or in the repository.
@bryanprimus
Copy link

I really need search functionality, I couldn't find typescript usage section. :)

@remix-run remix-run locked and limited conversation to collaborators May 9, 2023
@timdorr timdorr converted this issue into discussion #10466 May 9, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
Projects
None yet
Development

No branches or pull requests

2 participants