Summary:
Now that we finally have something we can screenshot ...
Just for the features page right now, will add some
"installation" instructions next.
Reviewed By: oprisnik
Differential Revision: D15898050
fbshipit-source-id: 9dfd3b1121799e7069336aac845ba2abdb3e42df
Summary: Just a minor version change, no changes expected.
Reviewed By: jknoxville
Differential Revision: D15897958
fbshipit-source-id: b103772159177e47884eb88e47f7b4077f77be03
Summary: The "next" link at the bottom right now leads to a 404 (was the old data page).
Reviewed By: jknoxville
Differential Revision: D15237635
fbshipit-source-id: 67ee7ace933d270b9e85b012e9128e1003c73ece
Summary:
I copied the wordings from Pascal's android setup and changed the API's to match the iOS one. 🙈
This doc explains how to build custom plugin in iOS
Reviewed By: passy
Differential Revision: D15200426
fbshipit-source-id: 0a3c966f7c74aae410c6b3ee643e5a38d33880de
Summary:
- Layout was in an odd spot. "Other platforms" is still weird, but it's at least next to the JS part now.
- Tutorial is the first thing after the intro.
Reviewed By: danielbuechele
Differential Revision: D15198470
fbshipit-source-id: 263582ee51f228a295be5952f5dc219e53c5e3e6
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
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
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
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
Summary: This was missing because it was still being generated in /docs.
Reviewed By: danielbuechele
Differential Revision: D15198144
fbshipit-source-id: aa9e77a1603fb63c1a7576091b70d8fa7124ab16
Summary: Documents init in the API reference and deletes the now redundant communicating page.
Reviewed By: danielbuechele
Differential Revision: D15198128
fbshipit-source-id: a9b88632b74edd7d9656ed888192db1fbe7f3642
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
Summary: This documents all pretty much the entire API.
Reviewed By: passy
Differential Revision: D15187834
fbshipit-source-id: 073c6a0dc40e3373967e9e5c5b7d44ab9c0aa07f
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
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
Summary: priteshrnandgaonkar pointed out that they sometimes overlap with the text.
Reviewed By: jknoxville
Differential Revision: D15182356
fbshipit-source-id: def39676d5dcce85aa0b41760cec0ec5cfb9398c
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
Summary: Describes the interface that clients should conform to to implement the layout plugin.
Reviewed By: danielbuechele
Differential Revision: D15166234
fbshipit-source-id: b86303f18f33762f09cfc503ece856cfcc887493
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
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
Summary: Adding a small ruler between each section on the landing page.
Reviewed By: jknoxville
Differential Revision: D15148067
fbshipit-source-id: 604f443c06eef16570dcdfbb21e121962b325127
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
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
Summary: Registered the site and it got indexed over night. Yay!
Reviewed By: jknoxville
Differential Revision: D15146529
fbshipit-source-id: 98a9ca68281d6b79f99a1da5d6f681340cb20ea1
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
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
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
Summary: Added the documentation of crash reporter plugin. Also removed the stale comment
Reviewed By: passy
Differential Revision: D13434177
fbshipit-source-id: bb8b14e989c91b35cd268daea12ac7fe590c5d5b
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
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
