Summary: Document the new release flow that does no longer involve local builds.
Reviewed By: antonk52
Differential Revision: D51115563
fbshipit-source-id: 0c518e51dba64b2325047d6b1e485216e48d9777
Summary:
^
Currently, it is a duplicate of the ui-debugger documentation image. The idea is creating this asset, for which we can obtain a URL, which can then be freely updated as we see fit.
Reviewed By: passy
Differential Revision: D49770514
fbshipit-source-id: 77a891c92e6aa803ad08a9b909ffd23d6a61c5a0
Summary:
Provide a documentation about marketplace feature of Flipper.
This should cover:
1. Introduction of the feature (plugin discovery, auto update)2.
2. Marketplace server - to list available plugins
3. Flipper settings - describe the new settings and how to enable4.
Closes https://github.com/facebook/flipper/issues/3545.
## Changelog
Pull Request resolved: https://github.com/facebook/flipper/pull/4395
Reviewed By: antonk52
Differential Revision: D42918936
Pulled By: passy
fbshipit-source-id: 50b10178b569ecc6ea65b736ea58db401cf686c6
Summary:
LukeDefeo called out that there's currently no guide for how to create changelog items.
I couldn't find another good page to add this to. Might be a good idea to expand this with further tips for making good contributions.
Reviewed By: LukeDefeo, nikoant
Differential Revision: D36702634
fbshipit-source-id: 15bc1dcf420ea923a714929eff8ac817efa56ceb
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).
This diff includes a new version of the images:
bg-plugin-lifecycle.png
regular-plugin-lifecycle.png
The old versions have been renamed to:
bg-plugin-lifecycle.bak
regular-plugin-lifecycle.bak
Reviewed By: aigoncharov
Differential Revision: D36630758
fbshipit-source-id: 29922750364e1dd6f959bd297e3b5d5e6cf1a9ac
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).
This diff includes a new version of the image 'flipper-communication-diagram.png'.
The old version has been renamed to 'flipper-communication-diagram.bak'
Reviewed By: aigoncharov
Differential Revision: D36628993
fbshipit-source-id: cb59785777926b4fb8b8bb3be2aa2439d3a580d0
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).
Reviewed By: passy
Differential Revision: D35898254
fbshipit-source-id: 67e3f3e344faf105f5a8f393c60441d6af3d62aa
Summary: Document how device identifiers are obtained and used to map apps and their running device.
Reviewed By: passy, aigoncharov
Differential Revision: D33431864
fbshipit-source-id: eff4475b3b5e796b58c04db872e814f3e7d5d79e
Summary: I noticed an error on loading "google-anaytics" script, "code-blocks-buttons" script and "network.png" screenshot (which is supposed to be a part of carousel on the main page) in dev console when Flipper docs website is opened. This diff fixes them. Looks like it positively affects load speed as well because each of these failed requests takes 1-2 seconds to resolve before the failure status returned.
Reviewed By: mweststrate
Differential Revision: D33313293
fbshipit-source-id: a1f6357d89121eefa2df9aeae783cd48bc3beaf5
Summary:
This diff changes the way on how plugin documentation is produced. Instead of keeping plugin documentation together with other docs, we will now keep it together with plugin code. There are multiple advantages of such solution:
1. We are generating docs for every plugin in a standartised way so all of them looks similar. We can also use plugin metadata for generation as well (e.g. take title, icon, oncall name etc from package.json).
2. Standartised plugin docs make it possible to build docs both for websites (public and internal) and for embedding into Flipper.
3. It will hopefully incentivise authors to write docs as they will be a part of plugin "package".
4. We can scaffold documentation template using scarf to further incentivise filling it.
Reviewed By: jknoxville
Differential Revision: D29378053
fbshipit-source-id: 66ea48dc9ba225fabfb256ae6a10f8c81eef6f5f
Summary:
The current desktop plugin tutorial was outdated as it has several steps that are now automated, and still referred to old APIs. This has been updated now.
Additionally left the intermediate code of the tutorial in the plugin, but splitting `index.tsx` into `index_table.tsx` and `index_custom.tsx` (which will be updated in the next diff)
Clarified the tutorial page labels a little bit to show that 3 pages are covering the Desktop plugin development process.
Changelog: Updated the Desktop plugin tutorial
Reviewed By: jknoxville
Differential Revision: D28990029
fbshipit-source-id: a06a7a774ceca3daf10f8e8fbd4e03191dbfd1cc
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
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
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
Summary: Fix a small issue we had with our mascot.
Reviewed By: danielbuechele
Differential Revision: D9180345
fbshipit-source-id: de1c34768b4f75202d78bd4404798a7549aa0457
