Update docs (#481, #485, #486)

* updated `codebase.md` (#481) * updated `roadmap.md` (#486) * removed generated api files for v0.5 (#485) * removed migration guide for v0.6 (#485) * added logic for api generation (#485) * `@ignore` in the jsdoc will ignore the prop generation through `react-docgen`
schrodinger · Sep 23, 2019 · df594c6 · df594c6
1 parent b7e94e4
commit df594c6
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 800 deletions.
diff --git a/build_helpers/react_documentation/generateMarkdown.js b/build_helpers/react_documentation/generateMarkdown.js
@@ -44,7 +44,15 @@ function generatePropDefaultValue(value) {
   return 'defaultValue: `' + value.value + '`\n';
 }
 
+function shouldIgnoreProp(prop) {
+  return (prop.description || '').includes('@ignore')
+}
+
 function generateProp(propName, prop) {
+  if (shouldIgnoreProp(prop)) {
+    return '';
+  }
+
   return (
     '### `' + propName + '`' + (prop.required ? ' (required)' : '') + '\n' +
     '\n' +

diff --git a/docs/api-v0.5/ColumnAPI.md b/docs/api-v0.5/ColumnAPI.md
diff --git a/docs/api-v0.5/ColumnGroupAPI.md b/docs/api-v0.5/ColumnGroupAPI.md