React-router: Native docs contain Browser/DOM references

Created on 9 Dec 2017  路  3Comments  路  Source: ReactTraining/react-router

Am very happy to use react-router on Native, thank you guys for the great software!

The API docs under /native/ (e.g. react-router/native/api/StaticRouter/ ) are a bit confusing, as a lot of the example code uses react-dom implementations of react-router-web components.

I am not sure if this is overlap by design (/native and /web /api use the same component docs?) or something else, but the Native docs would be more legible if they contain explicitly react-router-native examples, even if the difference in suffix is trivial to code-level component implementation.

stale

Most helpful comment

It may be worthwhile to rethink how you do the examples for native docs, as the current state of the documentation is an adoption deterrent

All 3 comments

This is a side effect of how we build the examples. We don't have unique copies for each flavor of the library, so it's code reuse getting in the way. Not sure of the best way to handle this, as just a search-and-replace step added to Webpack probably isn't sufficient.

It may be worthwhile to rethink how you do the examples for native docs, as the current state of the documentation is an adoption deterrent

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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

andrewpillar picture andrewpillar  路  3Comments

tomatau picture tomatau  路  3Comments

ackvf picture ackvf  路  3Comments

stnwk picture stnwk  路  3Comments

winkler1 picture winkler1  路  3Comments