Comments (6)
@christopherthielen I do agree that tutorials get the job done somehow, but I still think there should be more granular and "to the point" guides.
The helloworld tutorial imho covers too much unnecessary information that are unrelated to the library (like module loaders, creating react components, etc) and too little of the important, library related informations, like how to access the transition
object, how to redirect programatically, the differences between url based routing and state based routing. There could also be information like @elboman pointed on the differences between ui-router and react router and the benefits of ui-router (for those new to it).
I guess my point is that there should be granular guides like in React docs (eg. Rendering Elements, Components and Props, State and Lifecycle, etc) with in-depth explanation on each topic. This way all information is easy to find without looking through the tutorial or guessing/reasoning with the code in the examples.
from react.
Hi,
Thank you very much for the feedbacks!
I totally agree with you, we really need to create good documentation and tutorials to help people understand the possibilities with UI-Router and how to achieve common practices with the router.
@christopherthielen helped me set up typedoc and I started documenting the source to generate friendly API doc on the website, but it's still a WIP.
Once I'm done and 0.5.0 is finally out, I will focus on tutorials and general purpose docs.
Unfortunately I'm in the middle of moving abroad and these days have been really busy so I struggle to find the time right now, but once I'm set I'll finally be able to dedicate some stable work.
In the mean time and in general, would you like to help with this task? We could start defining a list of priorities for the project in terms of features and documentation in order to create a roadmap and ease the process of contributing for people who wants
from react.
No problem @elboman, I totally get it, I recently moved from Brazil to Denmark and I know how much time and energy it takes to move abroad.
As to contributing to the documentation, I'd love to. I don't have a lot of free time these days, but I can definitely contribute some of it.
I think having an API documentation is great once you get the hang of how the library works, but for completely new beginners it can be a bit frustrating not having a high level "5 minutes setup" guide to get the feeling of the library.
I was thinking we could have something like the React Quickstart docs, which are great for people completely new to React and approaches the most important topics for beginners in a very intuitive way. In that sense, there could be examples on how to install, register routes, transition between them, explaining the concept of routes as states and abstract states, etc.
What do you think?
from react.
In that sense, there could be examples on how to install, register routes, transition between them, explaining the concept of routes as states and abstract states, etc.
I think that's the intention of the tutorial series. Perhaps we missed the mark there? Maybe a good approach is to think how the tutorials can be improved?
https://ui-router.github.io/react/tutorial/helloworld
from react.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. This does not mean that the issue is invalid. Valid issues may be reopened. Thank you for your contributions.
from react.
This issue has been automatically closed.
from react.
Related Issues (20)
- Can ui-router/react support React18 new features? HOT 6
- testing ui router with relative paths
- {location: 'replace'} doesn't work in stateService.go(stateName, params, {location: 'replace'}) HOT 1
- useSref: "target="_blank" ignored when link contains child elements HOT 1
- Is this project still under active development? HOT 3
- Use same UIRouter instance inside different React.render(...) HOT 1
- Typescript demo errors on `1.0.1` HOT 1
- animating-transitions demo errors on `1.0.1` HOT 1
- Router.start() called more than once HOT 1
- 404 on react-dom.js on the tutorial pages HOT 2
- Path duplication after page refresh when using UIRouter pushStateLocationPlugin HOT 4
- Params of type json are not deserialized properly HOT 5
- States not gets enabled if there are nested lazy loaded states HOT 2
- UIView Doesn't Render with Usage of `urlService.rules.when` HOT 4
- Scroll restoration HOT 3
- Cannot use useRouter HOT 4
- Jest/Enzyme Transition Rejection/TypeError HOT 1
- UISref Component ignores target="_blank" on child anchor tag HOT 3
- Mocking UiRouter Classes with Jest HOT 4
- useCurrentStateAndParams don't reacting on initial state HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from react.