Commit Graph

26 Commits

Author SHA1 Message Date
Pascal Hartig
1afece19e7 JS table tutorial
Summary: Image is a placeholder, again.

Reviewed By: jknoxville

Differential Revision: D15185033

fbshipit-source-id: 6c60709d35da97c41a7c4328ef597747d6cea389
2019-05-03 10:21:21 -07:00
Pascal Hartig
2b0e91aa69 Add tutorial section and Android part
Summary:
JS is next. Screenshot on the intro page is really bad.
I hope danielbuechele can replace this. :)

Reviewed By: jknoxville

Differential Revision: D15184371

fbshipit-source-id: 2faaf46450d192ae400675c13b8d71fa1b7dab14
2019-05-03 10:21:21 -07:00
John Knox
c866ba9428 Fix website yarn start
Summary: Inlining the component docs header instead of reading it from the same file we write to.

Reviewed By: passy

Differential Revision: D15199683

fbshipit-source-id: dc34e25b5f8073aa582f90a14bc875c8e8c431db
2019-05-03 09:47:59 -07:00
John Knox
23b35e8006 Add debugging page
Summary: Information about debugging.

Reviewed By: passy

Differential Revision: D15198711

fbshipit-source-id: 587bca43d99908b666c58bb5279fadb61219e9a1
2019-05-03 09:47:59 -07:00
John Knox
0149296fc1 Reorder extending sidebar
Summary:
JS pages first, then client pages.
Would be nice if we had some sort of separator, but I think you can only have two levels.

Reviewed By: danielbuechele

Differential Revision: D15198312

fbshipit-source-id: 6c9f8d8775f513a55c256366448faed13b671767
2019-05-03 07:10:58 -07:00
John Knox
2588338c41 Tidy up and rename "Mobile Setup" page
Summary:
* Renamed to "Client Plugin API" to align with the "JavaScript Plugin API" page.
* Added some more info and reworded some parts.

Reviewed By: danielbuechele

Differential Revision: D15198192

fbshipit-source-id: 2c86b6a852e9ed52b0885eb5b7db8436028489d5
2019-05-03 07:10:58 -07:00
John Knox
733d61132e Restore UI components page in sidebar
Summary: This was missing because it was still being generated in /docs.

Reviewed By: danielbuechele

Differential Revision: D15198144

fbshipit-source-id: aa9e77a1603fb63c1a7576091b70d8fa7124ab16
2019-05-03 07:10:57 -07:00
John Knox
d5573644ac Delete communicating and move the missing info into js-plugin-api
Summary: Documents init in the API reference and deletes the now redundant communicating page.

Reviewed By: danielbuechele

Differential Revision: D15198128

fbshipit-source-id: a9b88632b74edd7d9656ed888192db1fbe7f3642
2019-05-03 07:10:57 -07:00
John Knox
f72e4b5122 Tidy up "Sending data to Plugins" page
Summary:
* Made the code snippets uniform across languages.
* Renamed to "Providing data to plugins" because sending hints at sending across the desktop-client connection which is misleading.

Reviewed By: danielbuechele

Differential Revision: D15198081

fbshipit-source-id: e2c318cdc6055c191f47e846b518c26dd21e4a68
2019-05-03 07:10:57 -07:00
John Knox
57af6fa2bf Add JS Plugin API reference page
Summary: This documents all pretty much the entire API.

Reviewed By: passy

Differential Revision: D15187834

fbshipit-source-id: 073c6a0dc40e3373967e9e5c5b7d44ab9c0aa07f
2019-05-03 04:30:09 -07:00
John Knox
49be7fd35f Redefine Js-Setup as JS Plugin Definition
Summary:
The purpose of this page wasn't that clear to me, though the content is pretty focused. I've changed it from JS setup to JS Plugin Definition, and reworded it a bit.
I think it makes sense if this specifies everything to do with plugins on the file system, and the next page talks about what you do in javascript.

Reviewed By: passy

Differential Revision: D15184829

fbshipit-source-id: 6335ebc8d4297ffcbf1ab9860b4f055fe5bbcf87
2019-05-03 04:30:09 -07:00
John Knox
a276af9c1f Show communcating with devices page
Summary:
This page got lost in the reorganisation. Adding it back.
There's still work to be done on the content and organisation of these docs.

Reviewed By: passy

Differential Revision: D15184349

fbshipit-source-id: 76256ba53189579bec363903dc4068a421cafc98
2019-05-02 12:38:31 -07:00
Pascal Hartig
df46c0c63e Add extending Layout Inspector docs
Summary:
Please give feedback on the sidebar placement.

This is only the Android part. I'll put up a second diff copying the iOS thing over
but hope someone can commandeer that and check for accuracy.

Reviewed By: priteshrnandgaonkar

Differential Revision: D15181454

fbshipit-source-id: d32081feefbfb0ffc38890e835a7d5f6b78667ab
2019-05-02 08:44:44 -07:00
John Knox
da44a02cad Add Implementing Layout Inspection docs
Summary: Describes the interface that clients should conform to to implement the layout plugin.

Reviewed By: danielbuechele

Differential Revision: D15166234

fbshipit-source-id: b86303f18f33762f09cfc503ece856cfcc887493
2019-05-01 09:15:51 -07:00
John Knox
821408056f Add Searching and Filtering page
Summary: I can't take credit for this, I found it in the internal wiki. Have just modernised it and made it public.

Reviewed By: danielbuechele

Differential Revision: D15165547

fbshipit-source-id: d59344aa6ad47be6ab32b88abcdfc14a7d20c775
2019-05-01 08:31:38 -07:00
John Knox
56b85dd6e3 Write up FlipperClient API.
Summary:
Specifies the API for implementing your own Flipper Client.
I believe this provides everything you need to know to build a flipper-compliant client.
The only snag is that the current certificate exchange procedure would require a change to allow for new OS's, device types etc. It would be much better if we had a TLS-opt out so you don't need to go through all that rigmarole.

Reviewed By: passy

Differential Revision: D15150550

fbshipit-source-id: 2878dcc174807c3f86c0562660e8a3e43e5777b1
2019-05-01 04:10:37 -07:00
John Knox
b3ec8b052b Add Setup and Extending top level navs
Summary: Distinguish between integrating flipper, and developing plugins.

Reviewed By: passy

Differential Revision: D15148448

fbshipit-source-id: 7c772fa1cea7d5ed789a984039afc37bc0b8a927
2019-04-30 11:06:45 -07:00
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
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
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
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
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
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
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