Commit Graph

332 Commits

Author SHA1 Message Date
John Knox
4c282cea1f Add architecture page and Internals section
Summary: Breifly documents the client-desktop relationship

Reviewed By: passy

Differential Revision: D15147712

fbshipit-source-id: 8292c580538c1cda03450a460a0e08f4a4b8cec2
2019-04-30 11:06:44 -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
Pritesh Nandgaonkar
e7200e36a3 Learn more points to getting started
Summary:
`/docs/understand.html` doesn't exist anymore. Also "learn more" in the landing page pointed to `/docs/understand.html` which was broken. Pointed "Learn More" to getting started doc page.

`/docs/understand.html` explained about rsocket which will be little overwhelming for the user to be navigated to right from the landing page.

Also removed the links pointing to  `/docs/understand.html`

Reviewed By: passy

Differential Revision: D15147954

fbshipit-source-id: cbd67d7f234c438507f24db946cd463e8827cb78
2019-04-30 09:46:32 -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
Pascal Hartig
eca569db42 Set up Algolia search
Summary: Registered the site and it got indexed over night. Yay!

Reviewed By: jknoxville

Differential Revision: D15146529

fbshipit-source-id: 98a9ca68281d6b79f99a1da5d6f681340cb20ea1
2019-04-30 04:16:39 -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
Pascal Hartig
f76db15bdb Edit Docusaurus edit URL (#421)
Summary:
Makes editing pages easier.
Pull Request resolved: https://github.com/facebook/flipper/pull/421

Reviewed By: danielbuechele

Differential Revision: D15121670

Pulled By: passy

fbshipit-source-id: a201de3ce84204a9478711a80f3557671de743ab
2019-04-29 08:09:50 -07:00
Pritesh Nandgaonkar
fd9b581162 Documentation for sharing flipper data
Summary: Added documentation for the Flipper's Import/Export feature

Reviewed By: passy

Differential Revision: D14539133

fbshipit-source-id: 66f85c46edd4ca644d2bbcd6e47dd9c88aa3618c
2019-03-20 06:59:28 -07:00
John Knox
a8fc858d4d Add custom ports to documentation
Summary:
Added instructions on using custom ports.

We probably want to put the headless instructions here too when they're ready.

Reviewed By: danielbuechele

Differential Revision: D13860469

fbshipit-source-id: 76537a36e6fc85e805a29830927e4d59ee4f73e8
2019-01-29 09:08:05 -08:00
Pritesh Nandgaonkar
9ec04d33e2 Back out "Revert D13434177: [Docs] Updated the website docs with the information of crash reporter plugin"
Summary:
Original commit changeset: 36e501b0ca70

The original diff was reverted because the sheriff thought that my diff broke the flipper test but it was not the case.Thus putting it back

Reviewed By: passy

Differential Revision: D13495123

fbshipit-source-id: 7e72dafe967236b968baf9d4741b3673f46a27cb
2018-12-20 06:05:25 -08:00
Mike Kelley
a1541b1c81 Revert D13434177: [Docs] Updated the website docs with the information of crash reporter plugin
Differential Revision:
D13434177

Original commit changeset: bb8b14e989c9

fbshipit-source-id: 36e501b0ca7031956b57c93429084a7bc673ef77
2018-12-17 11:08:29 -08:00
Pritesh Nandgaonkar
1bc566f813 Updated the website docs with the information of crash reporter plugin
Summary: Added the documentation of crash reporter plugin. Also removed the stale comment

Reviewed By: passy

Differential Revision: D13434177

fbshipit-source-id: bb8b14e989c91b35cd268daea12ac7fe590c5d5b
2018-12-17 11:08:28 -08:00
Daniel Büchele
95a7298d21 updating UI documentation
Summary:
adding documentation for more of our UI components.

Deleted some unused components, which were not working anyways.

Reviewed By: jknoxville

Differential Revision: D12896109

fbshipit-source-id: 959c7864240883869ad67283f80a3c189b94bf00
2018-11-05 03:12:23 -08: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
1904cc3521 Docs for notifications
Summary: as per title

Reviewed By: passy

Differential Revision: D10449043

fbshipit-source-id: 70fac302f9c5ebc4d7ca9950aa8fab1c3e71006e
2018-10-19 08:35:19 -07:00
Pritesh Nandgaonkar
9c96ab1565 Documentation for background plugin
Summary: Documentation for background plugin

Reviewed By: passy

Differential Revision: D10378898

fbshipit-source-id: 42f23b9464c41ee2f329301233c1e01d0ae05e95
2018-10-15 11:37:29 -07:00
John Knox
29a66f3605 Enable secondary page navigation
Summary: Allows for easier navigation through pages with multiple sections.

Reviewed By: danielbuechele

Differential Revision: D9811408

fbshipit-source-id: f47ad9d650dd4bd79710f64e4bb4485f3d4c4323
2018-09-14 05:01:51 -07:00
John Knox
01dc8ed6fd Add troubleshooting page
Summary: Adds a bunch of steps to take if you're having trouble.

Reviewed By: danielbuechele

Differential Revision: D9811295

fbshipit-source-id: 6802108e98850ab11764081491a528eb939d2224
2018-09-14 05:01:51 -07: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
36975a5d8e Add getting-started section about snapshots
Summary:
Mention the snapshot releases we now publish and how
to use them.

Reviewed By: jknoxville

Differential Revision: D9654559

fbshipit-source-id: 0b4721a29f93d92a27cc1833bfc98b5642461d94
2018-09-05 08:13:31 -07:00
John Knox
9c0d426673 Add establishing a connection to website sidebar
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/218

Reviewed By: passy

Differential Revision: D9239480

Pulled By: jknoxville

fbshipit-source-id: 34b909a28af0c15d524926419ff47b8381163075
2018-08-09 07:27:50 -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
Benjamin Pankow
1008dbb283 Create open source LeakCanary plugin
Summary: Adds a new plugin to support [LeakCanary](https://github.com/square/leakcanary), displaying memory leaks as they are detected. Each leak shows a hierarchical path from the GC root to the leaked object, and allows inspection of these objects' fields.

Reviewed By: jknoxville

Differential Revision: D8865149

fbshipit-source-id: 99bcf216578b9d6660ead7d48b9bafe0d20a6c08
2018-08-02 10:27:11 -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
Pritesh Nandgaonkar
07d75ce848 Rename Sample app from Sonar to Flipper
Summary: Renamed sonar sample app with flipper

Reviewed By: passy

Differential Revision: D9050608

fbshipit-source-id: 4e76e4c6cc8febb997ce32b4f78a2fab9792310d
2018-07-31 14:02:58 -07:00
Pritesh Nandgaonkar
5fc0d9833d Change the website branding
Summary: Updated the website with the new name flipper

Reviewed By: passy

Differential Revision: D9046642

fbshipit-source-id: e4c6e77ddba62b8ebedf5639dc7cc6375b857cd9
2018-07-31 14:02:58 -07:00
Hilal Alsibai
56cfe6600d Add Shared Preferences plugin docs
Summary: Moar docz

Reviewed By: danielbuechele

Differential Revision: D8752565

fbshipit-source-id: d7e4392e00dc06b0ffbebce491d5244b4b31a34d
2018-07-09 02:48:37 -07:00
Edoardo Tognoni
53753801b0 Open source the Sandbox plugin
Summary: This diff is mainly moving diffs around to open source the Sandbox plugin. I created the MD file writing some docs. The rest is just making our own FB implementation work

Reviewed By: danielbuechele

Differential Revision: D8731839

fbshipit-source-id: 27ac67223c6de9d1be406ab8c06b71b82d5407bc
2018-07-05 09:19:37 -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