Commit Graph

28 Commits

Author SHA1 Message Date
Michel Weststrate
7b8054f31c Fixed grayed out body text
Summary: As reported a few times in the internal chat

Reviewed By: passy

Differential Revision: D26813161

fbshipit-source-id: 8b834c7807a7634f23c3ab922bb43e288ea4bd68
2021-03-04 03:18:56 -08:00
Pascal Hartig
e188469acd Add public release docs
Summary: Per title.

Reviewed By: nikoant

Differential Revision: D25535920

fbshipit-source-id: 63fc1b7f5ea122478a3e82e3345d057bc7be37cd
2020-12-14 11:27:01 -08:00
Michel Weststrate
5a56ee65b8 Fix contributing image link
Summary: Better fix for D22662057 (485b4c9827) / https://github.com/facebook/flipper/pull/1396

Reviewed By: jknoxville

Differential Revision: D22663334

fbshipit-source-id: 3a5f967e857ccc819be34903e3fb982e90823040
2020-07-24 03:38:05 -07:00
Lukas Kurucz
4d13b7ca2a Add architecture overview (#1073)
Summary:
Based on the issue here https://github.com/facebook/flipper/issues/967, I'm adding the flipper diagram to a documentation.
It should help explain briefly how does all parts communicate together and visualise key terms.

## Changelog

- Add Flipper architecture diagram to documentation
Pull Request resolved: https://github.com/facebook/flipper/pull/1073

Reviewed By: jknoxville

Differential Revision: D21278322

Pulled By: passy

fbshipit-source-id: 3cd8c71b2595b86911f5c9061bc2e8119da1d315
2020-05-29 07:05:06 -07:00
John Knox
a0cd37b5ef Distinguish links from regular text
Summary: Changes the link color to something that isn't very similar to the rest of the text.

Reviewed By: nikoant

Differential Revision: D21328856

fbshipit-source-id: 9467e368411caeb58e00642b48ef4413d285850e
2020-04-30 10:26:24 -07:00
John Knox
b483e0688d Make h3 smaller than h2
Summary:
After moving to docusaurus v2, our h3 tags are bigger than the h2 tags.
Removing our custom css fixes this, so doing that to get closer to the default theme.

Reviewed By: mweststrate

Differential Revision: D21283840

fbshipit-source-id: ceaf7488b90bbb90a463037d9e1dfcca1d694366
2020-04-28 17:33:25 -07:00
John Knox
5f1a0548f5 Migrate website to Docusaurus 2
Summary:
Docusaurus 2 is quite a lot more powerful than docu 1 it turns out.
This should convert the website fully.

* [done] Go through migration guide https://v2.docusaurus.io/docs/migrating-from-v1-to-v2
* [done] Convert landing page html
* [done] Convert all images to img tags
* [done] Convert all .md files to .mdx
* [done] Make sure ui-doc generation and including still works
* [done] Scan every page visually for sanity check
* [done] Make sure footer still works
* [done] Make sure search still works
* [done] Change all links/ to links/index
* [done] Change all links.md to links
* [done] Add some custom css to make the navbar look like the old one and darken the footer.

Reviewed By: passy

Differential Revision: D21158717

fbshipit-source-id: 5f45b711b1b6fd5ece4c5c15c55635c7ebbfb568
2020-04-27 04:05:01 -07:00
Nicolas Charpentier
201203ab84 Refresh Getting Started with the latest React Native integration (#676)
Summary:
Sync the Getting Started section about React Native integration with the latest changes in https://github.com/facebook/react-native/pull/27426.

## Changelog

Refresh Getting Started with the latest React Native integration
Pull Request resolved: https://github.com/facebook/flipper/pull/676

Test Plan: Tested in RN's template.

Reviewed By: mweststrate

Differential Revision: D18853584

Pulled By: passy

fbshipit-source-id: d001046106743b68d2f08b084c7618d8f768dea1
2019-12-10 06:07:03 -08:00
John Knox
c1b320be6e Move "Download" out of the Mac button on front page
Summary:
This didn't look quite right to me, "Download Mac", "Linux", "Windows".
Changed it to a separate "Download for", with "Mac", "Linux" and "Windows" buttons.

Reviewed By: passy

Differential Revision: D18225271

fbshipit-source-id: d644570d072029fc792cd9d9c18d8616ada0017b
2019-10-30 11:23:28 -07:00
Andres Suarez
54ebb44dda Tidy up Flipper license headers [2/2]
Reviewed By: passy

Differential Revision: D17863710

fbshipit-source-id: 5b249bdd1c06d3a526b250b035b797d0c8e796eb
2019-10-11 13:46:45 -07:00
Pascal Hartig
6b58e813e5 Add GA
Summary: Add Google Analytics code.

Reviewed By: danielbuechele

Differential Revision: D17398649

fbshipit-source-id: 79acd7a9d3ac19a25deea3f84989860308f2787e
2019-09-17 03:12:18 -07:00
Pascal Hartig
7e0b66ae8e Add linux/windows download buttons
Summary:
There's probably a more elegant way for doing this
so please let me know if you can think of something.

Reviewed By: danielbuechele

Differential Revision: D17318727

fbshipit-source-id: 9afcc30205171cfb07f0a749c552692cb40a3ced
2019-09-12 08:12:43 -07:00
Pascal Hartig
6dda7d2b63 More headers
Reviewed By: jknoxville

Differential Revision: D15199272

fbshipit-source-id: d46355a284a6e2acdaccd622dfd4419b06e61a61
2019-05-03 12:08:04 -07:00
Pascal Hartig
531b5e850c JS custom UI tutorial
Summary:
- Adding tutorial for custom JS UI
- optimizing screenshots
- fixing overlapping screenshots on landing page

Reviewed By: jknoxville

Differential Revision: D15198105

fbshipit-source-id: db53403b84a2c422650a4f80e959dad6e984d274
2019-05-03 10:21:22 -07:00
Pascal Hartig
adba73ba3c Increase top padding for code buttons
Summary: priteshrnandgaonkar pointed out that they sometimes overlap with the text.

Reviewed By: jknoxville

Differential Revision: D15182356

fbshipit-source-id: def39676d5dcce85aa0b41760cec0ec5cfb9398c
2019-05-02 10:59:13 -07:00
Daniel Büchele
8734b99f8d fixing links, adding nice buttons
Summary: as per title

Reviewed By: jknoxville

Differential Revision: D15167533

fbshipit-source-id: 67d059c478bf0608b598ba7cd6be19157ff41900
2019-05-01 11:21:54 -07:00
Daniel Büchele
563d23a514 docs: update screenshots
Summary:
Updating screenshots
adding screenshot slideshow to landing page

Reviewed By: passy

Differential Revision: D15164431

fbshipit-source-id: a7201f59205593e38b48bce87cacdb58e9b2b180
2019-05-01 03:22:35 -07:00
Daniel Büchele
1bab9ced96 docs: landing page ruler
Summary: Adding a small ruler between each section on the landing page.

Reviewed By: jknoxville

Differential Revision: D15148067

fbshipit-source-id: 604f443c06eef16570dcdfbb21e121962b325127
2019-04-30 10:09:11 -07:00
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
6c9d62c5da Fix CSS on landing page
Summary: fixing layout bug due to docusaurus upgrade

Reviewed By: passy

Differential Revision: D15122111

fbshipit-source-id: 7ecbbb34322d38f9da55bcad2e838067f83f8376
2019-04-30 02:58:04 -07:00
Pascal Hartig
d41df85ab7 Add codeblock buttons
Summary: Shamelessly ripped off from docusaurus.io

Reviewed By: jknoxville

Differential Revision: D15123501

fbshipit-source-id: 10451c72494e022af5887d4c78ef0db1ff581254
2019-04-29 15:43:22 -07:00
Pascal Hartig
ffea2ee30e Update docusaurus dependencies (#419)
Summary:
All bumps are within range, so this shouldn't introduce any breaking
changes.
Pull Request resolved: https://github.com/facebook/flipper/pull/419

Reviewed By: danielbuechele

Differential Revision: D15120854

Pulled By: passy

fbshipit-source-id: dee4b52947cb548d13cd4bf625b29e3a643d8fc3
2019-04-29 13:32:22 -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
Pascal Hartig
5e0271cfc3 Add SVG mascot exports
Summary:
It's easier to find when they're in the repo. Exported them
from the AI template.

Reviewed By: priteshrnandgaonkar

Differential Revision: D9789825

fbshipit-source-id: ca717d130495842dcab4d06e02986d3df598dbe6
2018-09-13 08:58:03 -07:00
Pascal Hartig
3abe33af14 Flip the Flipper tooltip
Summary: Fix a small issue we had with our mascot.

Reviewed By: danielbuechele

Differential Revision: D9180345

fbshipit-source-id: de1c34768b4f75202d78bd4404798a7549aa0457
2018-08-06 14:11:54 -07:00
Daniel Büchele
7a82d56eb6 fixing links on website
Summary:
fixing broken links for:
- Twitter account
- App download
- FlipperKit image on landing page

Reviewed By: passy

Differential Revision: D9131794

fbshipit-source-id: 0e7db0ebd57757684571f0325543c35ce3ba9bec
2018-08-02 06:12:31 -07:00
Daniel Buchele
f7d487dd76 fbshipit-source-id: 2cd940396d650342920b28835f6e672febe6b55c 2018-06-12 03:39:09 -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