Add docs for V2 #692
Add docs for V2 #692
Conversation
pradeepnschrodinger
requested review from
somavara,
abhisheksingh2410,
karry08 and
AmanGupta2708
pradeepnschrodinger
added
documentation
v2.0-beta
|
How will user switch between v1 and v2 docs ? |
They can't. We never had this feature implemented. :( |
| @@ -31,7 +31,7 @@ var FILES_TO_READ = [ | |||
| }, | |||
| { | |||
| path: path.join(PROJECT_ROOT, 'src/FixedDataTableCellDefault.js'), | |||
| name: 'Cell', | |||
| name: 'DataCell', | |||
There was a problem hiding this comment.
is the component renamed or it was mistyped here
There was a problem hiding this comment.
Cell is the older and now deprecated component.
DataCell is the newer replacement. (#687 )
| }; | ||
|
|
||
| class DocsPage extends React.Component { | ||
| render() { | ||
| const HTML = DOCS_MARKDOWN_FILES[this.props.page.location]; | ||
|
|
||
| let pageClassname = 'pageBody'; | ||
| if (this.props.page.pageClassname) { |
There was a problem hiding this comment.
is page always defined here
There was a problem hiding this comment.
it should be, but I'll smoke test it.
It's hard to immediately know without prop types defined...
|
How does the auto-generate thing works? |
|
LGTM |
@karry08, check out buildAPIDocs.sh. It uses react-docgen internally. |
Description
This adds documentations for the v2 release.
I added a separate section for Plugins and Public API.
Currently the docs for Public API methods/state are written manually, but in the future we want this to be auto-generated.
Screenshots:
Types of changes
Checklist: