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

[Doc] codegen improvements umbrella #2586

Closed
2 tasks done
newoga opened this issue Dec 18, 2015 · 5 comments
Closed
2 tasks done

[Doc] codegen improvements umbrella #2586

newoga opened this issue Dec 18, 2015 · 5 comments
Labels
discussion docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view

Comments

@newoga
Copy link
Contributor

newoga commented Dec 18, 2015

This issue is to track improvements to documentation generation that we would like to have.

  • Indicate which props are deprecated and information on the new appropriate/supported behavior
  • Add ability to selectively hide props from documentation (like internal props)
@newoga
Copy link
Contributor Author

newoga commented Dec 18, 2015

I haven't given this topic much thought but I think @oliviertassinari mentioned in a PR that he has some more ideas on what he wanted to do with the doc generation.

@alitaheri alitaheri added docs Improvements or additions to the documentation Core discussion labels Dec 18, 2015
@alitaheri alitaheri added this to the Improve the documentation milestone Dec 18, 2015
@oliviertassinari
Copy link
Member

@newoga Thanks for opening this issue.
Indeed, I plan to clean up a bit what we have started with the documentation:

  • using the new deprecatePropType where we can and make the codgen displaying the warning message in the description.
  • update the examples tu use stateless function components where possible.

I don't know how to achieve this, but it would be great to document function arguments of properties.

@alitaheri alitaheri added the umbrella For grouping multiple issues to provide a holistic view label Dec 22, 2015
@oliviertassinari
Copy link
Member

I think that we can close this issue.

@newoga
Copy link
Contributor Author

newoga commented Dec 30, 2015

@oliviertassinari Feel free to close or if there's anything else in the pipeline I can update the description.

Thanks!

@oliviertassinari
Copy link
Member

The last task in the pipeline is #2417.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view
Projects
None yet
Development

No branches or pull requests

3 participants