Skip to content
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

Looking for help with documentation #18

Open
ide opened this issue Oct 29, 2015 · 7 comments
Open

Looking for help with documentation #18

ide opened this issue Oct 29, 2015 · 7 comments

Comments

@ide
Copy link
Member

ide commented Oct 29, 2015

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.

@cancan101
Copy link
Contributor

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

@qbig
Copy link

qbig commented Nov 4, 2015

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

@ide
Copy link
Member Author

ide commented Nov 4, 2015

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

@thorbenandresen
Copy link

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.

@ide
Copy link
Member Author

ide commented Nov 20, 2015

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

@thorbenandresen
Copy link

@bfarrgaynor
Copy link

Did this get any traction?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants