auto_route 2.+ docs?

[Milad-Akarie]

Hello everyone, With the latest release 2.2.0 out I think we've fixed and enhanced most of the important navigation concepts and we are now ready to focus on writing some good docs because what we have now doesn't seem to help much.

What do you guys think are most concepts or areas that new/existing auto_route users struggle to get familiar with? Would you prefer working examples are explained snippets?

[mikepyts]

@Milad-Akarie hello, once I have started to work with auto-route 2.0 after 1.0 seems like the biggest gap in understanding was for using the right router, especially once we are going deeper with a real mix of stack router + tabs + nested navigators inside tabs and navigations between nested tabs pages. The second thing are missing docs for helpers like pushNamed(), pushAll() which sometimes are very useful but require time to get into the source a bit. Thanks for the topic!

[Milad-Akarie]

@mikepyts I know about the first one, Thanks for reminding of the navigation methods.

[theweiweiway]

For the navigation methods - I've updated them a bit here: https://autoroute.vercel.app/basics/navigation

Open to suggestions tho

[SalahAdDin]

What happened with tabs navigation? The named parameter 'usesTabsRouter' isn't defined.

[Milad-Akarie]

@SalahAdin no need to use it, using the AutoTabsRouter widget is enough.

[SalahAdDin]

@salahadin no need to use it, using the AutoTabsRouter widget is enough.

could you address us to the correct documentation about that widget?

[Milad-Akarie]

@SalahAdDin We're still working on the docs, it's pretty straight forward you should be able to implement it following this example https://github.com/Milad-Akarie/auto_route_library/blob/master/auto_route/example/lib/mobile/screens/home_page.dart in this example we're using an AutoTabsScaffold to simplify the implementation.

[SalahAdDin]

It should be good to have an example for independent sections, and also, combining with drawer navigation, if it is possible.

[Milad-Akarie]

@SalahAdDin what do you mean by independent sections?

[SalahAdDin]

For example, one Dashboard screen with four tabs and one Home screen with two tabs.

[Milad-Akarie]

@SalahAdDin ya that's simple, we're talking mobile here?

[SalahAdDin]

yeah, for doing responsive dashboards(tablet/mobile).

[AcodeWang]

I have 3 question :

1. for the version of auto_route & auto_route_generator, is it a good way to keep 2 package same version name ? For now the auto_route [latest_version] = 2.2.0, but auto_route_generator [latest_version] = 2.1.0. It could be a little confusing.

2. I found in the doc for Cross-tab Navigation : I could use context.navigateTo(AccountRouter(children: AccountDetailsRoute())) or context.tabsRouter.navigate(AccountRouter(children: AccountDetailsRoute())) What's the diffrence between navigateTo() and router.navigate()

3. With navigation 2.0 we can navigate without pushing to the stack (for example on web no history in back button), how could I achive this with auto_route ?

[jlnrrg]

Ok, it should be no secret that I am a pretty big fan of https://autoroute.vercel.app/ . (the readme has to reflect the website. It is confusing to have different documentation states) I like the concept of having a website to research certain use cases and see snippets for that. On the otherhand I also like to get inspired looking at an example which implements everything that is possible with the library.

For new users these concept seem to be problematic:

1. getting the right router
2. setting up children of a route (+ how to implement the additional router that is needed for that)
3. different ways of passing arguments
4. navigating without context

For advanced users these might seem useful:

1. implementing AuthGuard
2. implementation of RouteAware and RouteObservers in general (and maybe what to do with it)
3. an overview of usefull autoRoute classes and how to access them
4. different types of tabRouter pushing 4.1. pushing a route from another tab in the same tab 4.2. pushing a route from another tab in the other tab and setting it active 4.3. pushing a route from another tab in the top most route (outside of the tab)

[jlnrrg]

Is there any news on the state of a documentation? :pray: also @theweiweiway please include a version number in https://autoroute.vercel.app/ (I think it's yours if I remember correctly). It becomes very confusing searching for information and then figuring out that it has become outdated. (same for the readme, I guess)

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions

[SalahAdDin]

Is there any news on the state of the documentation? 🙏 also @theweiweiway please include a version number in https://autoroute.vercel.app/ (I think it's yours if I remember correctly). It becomes very confusing searching for information and then figuring out that it has become outdated. (same for the readme, I guess)

@Milad-Akarie I think it was not done.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions

[SalahAdDin]

Is there any news on the state of the documentation? pray also @theweiweiway please include a version number in https://autoroute.vercel.app/ (I think it's yours if I remember correctly). It becomes very confusing searching for information and then figuring out that it has become outdated. (same for the readme, I guess)

It seems this repository is not actively maintained, isn't it @Milad-Akarie ?