Commit Graph

14 Commits

Author SHA1 Message Date
Lorenzo Blasa
706ad760dc Edit desktop-plugin-structure.mdx using inpage editor
Summary:
This diff has been automatically generated by the inpage editor.
                        If you want to update this diff, go through the preview link that would be attached to the test plan.
                        Please ensure you are editing the same page that was used to create this diff.

Reviewed By: passy

Differential Revision: D37853011

fbshipit-source-id: 1d68d5a80b30bb1b1cdf5703272717dadbe3a977
2022-07-14 10:07:35 -07:00
Kevin Strider
490fdbd4c4 desktop-plugin-structure.mdx (Creating Plugins - Plugin Structure)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: passy

Differential Revision: D37035954

fbshipit-source-id: e6e6a0e23989b676a59390ab6f0d068b449ee21d
2022-06-10 02:17:00 -07:00
Michel Weststrate
7efad4201c Document how to use Node.js api's
Summary:
* Documented `npx flipper-server`
* Documented how to properly interact with the OS from Flipper plugins

Reviewed By: antonk52

Differential Revision: D33361929

fbshipit-source-id: 3028de2bf77a9ee6d9e521c1a53cff2388c936ea
2022-01-04 09:06:15 -08:00
Anton Nikolaev
ceba421997 Prepend mdx files which used as includes with underscore to avoid creating and indexing pages from them
Summary:
By default docusaurus generates pages and routes for every mdx file it finds under the root dir. So even for the mdx files which are only used as includes and don't even have headers, page is still created, then index and often looks very weird, e.g. title is the same as file name etc. See e.g. this one: https://www.internalfb.com/intern/staticdocs/flipper/docs/fb/portal-troubleshooting/

I went through Flipper docs and renamed all mdx files which are only used as includes to prepend them with underscore. Everything which name is starting with underscore, or which is inside a folder which name is starting with underscore is considered private by docusaurus and skipped.

Reviewed By: passy

Differential Revision: D32722547

fbshipit-source-id: 0524d4dd56960714fbdd2b01ad8383cd16de4948
2021-11-30 13:26:17 -08:00
Michel Weststrate
c4538c48d6 Remove deprecated documentation
Summary: Sandy is idiomatic now, cleaned up old docs to avoid confusion as in https://github.com/facebook/flipper/issues/2611.

Reviewed By: passy

Differential Revision: D30908794

fbshipit-source-id: c4076f1d24b193f71923d19eeed631763bb9dacb
2021-09-14 03:12:41 -07:00
Hafiz Saqib Javed
029b00c4ca Added missing quotation marks (#2709)
Summary:
The documentation had a missing quotation mark.

## Changelog
Fixed missing quotation mark

Pull Request resolved: https://github.com/facebook/flipper/pull/2709

Test Plan: No code affected

Reviewed By: passy

Differential Revision: D30450063

Pulled By: jknoxville

fbshipit-source-id: 8e70d321d5cbf51439c67cca23471e208d0861b2
2021-08-20 08:20:50 -07:00
Pascal Hartig
781df776f2 Rename default branch references to main (#2689)
Summary:
I really hope I hit everything and didn't break anything that wasn't
referring to branch names.

Pull Request resolved: https://github.com/facebook/flipper/pull/2689

Test Plan:
_eyes

CI

|[Site Preview: flipper](https://our.intern.facebook.com/intern/staticdocs/eph/D30305789/V2/flipper/)

Reviewed By: timur-valiev

Differential Revision: D30305789

Pulled By: passy

fbshipit-source-id: 5daaa09250bb96bb50be679fc01dae86c666eb73
2021-08-13 15:00:39 -07:00
Ananya Arun
5e350add4f Update desktop-plugin-structure.mdx to add supportedApps
Summary:
This diff has been automatically generated by the inpage editor

Addresses the comment https://www.internalfb.com/diff/D30193668?dst_version_fbid=579384449899538&transaction_fbid=938191196910073

Reviewed By: passy, mweststrate

Differential Revision: D30248046

fbshipit-source-id: 1ef1e5ad75cdabf716ab7b81314e77e2dd9de5ce
2021-08-12 03:51:18 -07:00
John Knox
13ce7741a6 Fix broken links
Summary: Noticed some broken links while converting plugins

Reviewed By: priteshrnandgaonkar

Differential Revision: D27997670

fbshipit-source-id: fd2715db010a042f749e0908b44a3fb3c6aa6f18
2021-04-26 08:29:12 -07:00
Anton Nikolaev
5b0f7e8757 Docs on how to include fb-only parts into open-sourced plugins
Summary: Added docs on how to include fb-only parts into open-sourced plugins

Reviewed By: mweststrate

Differential Revision: D27678276

fbshipit-source-id: e0c3de8ed57a7d25f291e8e6ac15ed32812a0cbc
2021-04-09 08:57:15 -07:00
Bartosz Kaszubowski
40e6cdebb1 improve docs code blocks highlighting (#2049)
Summary:
This PR adds missing Objective-C entry to the Docusaurus config, fixes Objective-C code blocks label and adds or replaces several code block labels to improve the currently highlighted blocks.

Prism in Docusaurus by default also includes syntax highlight for `jsx` and `tsx`, which improves the nodes and props highlight, so I have used those syntaxes in few places too.

I have also fixed one typo that I have spotted and my IDE made a cleanup of whitespaces in edited files.

## Changelog

* [website] improve docs code blocks highlighting

Pull Request resolved: https://github.com/facebook/flipper/pull/2049

Test Plan:
The changes have been tested running Flipper website on `localhost`.

## Preview

<img width="650" alt="Screenshot 2021-03-12 150934" src="https://user-images.githubusercontent.com/719641/110951135-fff20d00-8344-11eb-96db-1bdc82c8d5ea.png">

<img width="649" alt="Screenshot 2021-03-12 151022" src="https://user-images.githubusercontent.com/719641/110951268-2ca62480-8345-11eb-9d3b-1a48f1267776.png">

Reviewed By: priteshrnandgaonkar

Differential Revision: D27336599

Pulled By: passy

fbshipit-source-id: c2dfb3d8cad4675da0f5e1270cada1e56a0175c0
2021-03-29 02:46:11 -07:00
John Knox
08b594db5c Upgrade static docs plugin
Summary:
Upgrade the static docs plugin.

You no longer need to import OssOnly and FbInternalOnly in markdown files, so removed those imports too.

Reviewed By: passy

Differential Revision: D26580059

fbshipit-source-id: 2763de2f5fbef41ec2ac7f7bdd147418badb78b6
2021-02-22 09:17:44 -08:00
Anton Nikolaev
1c898bd2da Device plugin management (5/n): Docs
Summary: Updated docs to mention the new way of specifying device plugins compatibility metadata.

Reviewed By: mweststrate

Differential Revision: D26424203

fbshipit-source-id: 313e15ee54a8877c95850a37a13c5684b3c165f0
2021-02-16 10:50:19 -08:00
Michel Weststrate
69dae5c8e5 Restructured dev workflow docs
Summary: This diff unifies setup and workflow information that was scattered a bit around into one cohesive 'Development workflow' subsection in the 'creating plugins' section of Flipper.

Reviewed By: nikoant

Differential Revision: D25612288

fbshipit-source-id: 5fa7f2d000fb7ab3e1b5c5a4fc8cc1f209252f41
2020-12-17 07:40:58 -08:00