Commit Graph

7 Commits

Author SHA1 Message Date
Daniel Büchele
3b03a3d605 docs: add features page
Summary: Adding a "features" page to the to bar and splitting plugin descriptions from their setup instructions.

Reviewed By: jknoxville

Differential Revision: D15147464

fbshipit-source-id: b2106d825454c3b2989eb1e536b128ef9b6d0247
2019-04-30 07:39:16 -07:00
Daniel Büchele
640dee6645 auto generated UI docs
Summary:
Using `react-docgen` to automatically generate docs for our UI components.
React-docgen parses the files in `components/ui` and using comments and flowtypes to generate structured information about the UI components.

For higher-order-components `react-docgen` is not able to get the information. As we are using HOC often as part of emotion's styled-components, I added a custom parser for HOCs. Using babel/parser I am parsing the components and using their doc-comments to generate the structured description.

Then, the description generated by react-docgen and my custom parser is used to generate markdown which is added to the `ui-components.md` file of our docs.

Plus: Added some styling around the documentation of props, mostly table styles.

Reviewed By: jknoxville

Differential Revision: D12896110

fbshipit-source-id: 1337c924c06e10a5d3aa752579428fd2cc7b4743
2018-11-05 03:12:23 -08:00
Daniel Büchele
9d2713cdc0 docs update
Summary: update docs to match new styling API and rename from Sonar to Flipper.

Reviewed By: passy

Differential Revision: D10107270

fbshipit-source-id: 75d7a06c88795aa1d3dce8f135f3a9c21d5d038d
2018-09-28 10:42:22 -07:00
Daniel Büchele
159ce69bc8 Docs
Summary: renaming flipper in docs

Reviewed By: passy

Differential Revision: D9871491

fbshipit-source-id: 7a7dcc8421229f3a253efc6a49202dad5c7315d0
2018-09-18 07:01:17 -07:00
Pritesh Nandgaonkar
8db555b259 Replace sonar with flipper in docs
Summary: Replaces sonar with flipper in the docs of a website

Reviewed By: passy

Differential Revision: D9046564

fbshipit-source-id: 55d03d787489406571ea0b4ac0adbc0daaa95cd4
2018-07-31 14:02:58 -07:00
Michael Evans
dba07a33c7 Fix typo in ui-components docs
Summary: Closes https://github.com/facebook/Sonar/pull/26

Differential Revision: D8379209

Pulled By: danielbuechele

fbshipit-source-id: b5f2fe8de84e48a9cd43bb8cd3e79e21e6be470f
2018-06-12 05:49:01 -07:00
Daniel Büchele
fbbf8cf16b Initial commit 🎉
fbshipit-source-id: b6fc29740c6875d2e78953b8a7123890a67930f2
Co-authored-by: Sebastian McKenzie <sebmck@fb.com>
Co-authored-by: John Knox <jknox@fb.com>
Co-authored-by: Emil Sjölander <emilsj@fb.com>
Co-authored-by: Pritesh Nandgaonkar <prit91@fb.com>
2018-06-01 11:03:58 +01:00