ex-navigator icon indicating copy to clipboard operation
ex-navigator copied to clipboard

Looking for help with documentation

Open ide opened this issue 9 years ago • 7 comments

Some more documentation around what props are supported and what they do would be pretty useful along with a short example. The blog post explains why ExNavigator is the way it is but doesn't comprehesively detail all the props. If anyone has suggestions for how to nicely format the docs (w/a preference to legibility more than prettiness) something more than a README would be nice.

ide avatar Oct 29 '15 00:10 ide

Would be good to have a couple sentences comparing ex navigator to navigator. Not sure this comparison is explicit anywhere.

cancan101 avatar Oct 29 '15 01:10 cancan101

Is this already being worked on @ide ? I am willing to give it a try.

qbig avatar Nov 04 '15 08:11 qbig

@qbig I have not heard that anyone is currently working on this. Would appreciate your help.

ide avatar Nov 04 '15 08:11 ide

I have made a runnable Example of the most basic version here: https://github.com/Thorbenandresen/ExNavigatorExample

However I currently struggle to implement the top modal example. Jason Brown's part works fine for me, but I have problems with implementing the second ExNavigator. Help appreciated.

thorbenandresen avatar Nov 20 '15 21:11 thorbenandresen

react-docgen probably makes the most sense -- we don't want to spend a lot of time updating docs so using the code to generate docs is the most appealing idea to me. Maybe a small usage example outside of the code too, if react-docgen supports that. https://github.com/reactjs/react-docgen

ide avatar Nov 20 '15 23:11 ide

ExNavigator + top modal: https://github.com/Thorbenandresen/ExNavigatorExampleModal

thorbenandresen avatar Nov 21 '15 00:11 thorbenandresen

Did this get any traction?

bfarrgaynor avatar Jan 08 '16 18:01 bfarrgaynor