Commit Graph

9 Commits

Author SHA1 Message Date
John Knox
142eb8f9ea Add doc markers to code
Summary: Referencing these from the wiki should be better than copy-pasting so we know they are up-to-date

Reviewed By: passy

Differential Revision: D23564251

fbshipit-source-id: ad90fcaa88c3c638212a277ce49a5faa41cd07df
2020-09-07 06:40:30 -07:00
John Knox
f33d4b3f9e Add internaldocs-fb-helpers lib
Summary:
This adds a new npm package "internaldocs-fb-helpers", and shows example usage in the flipper package.

This will stop everyone from having to inline the function definitions everywhere as is currently the case.

(It's using the old internaldocs name, to match the existing docusaurus-plugin-internaldocs-fb package - I don't think that's a big deal.)

It currently exports two methods:

* `fbContent(internalContent, publicContent)`
  * Allows you to return internal or external content based on build variant.
  * Has named args so you don't accidentally put internal stuff in the external arg.

* `isInternal(): boolean`
  * Not strictly necessary, but helps if you want to write your docs using an boolean variable rather than a switching function every time.

* `fbInternalOnly(internalContent)`
  * Convenience method for when you want internal content, or nothing.

I could have put these inside the existing docusaurus plugin, but that has docu v2 as a peer dependency, and I want these helpers to work on v1 as well, so made it a standalone package.

Reviewed By: passy

Differential Revision: D23474462

fbshipit-source-id: 22e5be6de2f3233deb298f1542a06e3575b6555a
2020-09-07 03:41:10 -07:00
Pascal Hartig
787e578a33 Document PACK download mechanism
Summary:
This is a first stab at documenting the new core distribution mechanism.
There are definitely areas I just brush over that should be expanded further,
but hopefully the release process and testing steps at the end help to clarify
some of the issues we've seen recently.

Reviewed By: mweststrate

Differential Revision: D23453713

fbshipit-source-id: 9efcfca1fbdbf5606080510c3e80bd19b49caf10
2020-09-02 06:13:47 -07:00
Michel Weststrate
8a5860cb78 API reference documentation
Summary:
Documented all exposed Sandy APIs plugin developers should know about.

Honestly didn't proof-read it myself yet, but wanted to publish this diff at least before PTO, so that the information is available to anyone interested / playing with sandy

Reviewed By: jknoxville

Differential Revision: D22976373

fbshipit-source-id: c30918201d2feeb306ca0d9a3ae1ec10bdf7e2f5
2020-08-24 04:57:02 -07:00
John Knox
baa29d0b49 Manually fix up imported pages
Summary:
I've gone through all imported pages and fixed all images and links (and anything else) that didn't get converted successfully.

Also changed the new # headings to use ##, because it works better here.

And organized the sidebar like it was on the wiki

Reviewed By: passy

Differential Revision: D23241772

fbshipit-source-id: 7eab8d7d520c5d605525d9b4ad9b12b48ca92bcc
2020-08-20 12:48:57 -07:00
John Knox
c6569470f4 Import internal pages from wiki
Summary:
This is the unadulterated output from running:
`yarn start static-docs-from-wiki --wiki_name Flipper --site_dir xplat/sonar/website`

Reviewed By: passy

Differential Revision: D23241773

fbshipit-source-id: 136e99130c77bedfb66bb31e31a7b331278857bb
2020-08-20 12:48:57 -07:00
John Knox
b1e16a3160 Move using at facebook wiki page to website
Reviewed By: passy

Differential Revision: D23029433

fbshipit-source-id: bc1559fbeed9ad6838d5793000e6bd5f594bba0b
2020-08-11 03:08:36 -07:00
Anton Nikolaev
09269ddd58 Documented plugin release workflow
Summary: See title

Reviewed By: jknoxville

Differential Revision: D22410580

fbshipit-source-id: 79cc5cf1d2a04a2edf7695bdb0e3d16b38baaae9
2020-07-07 05:39:33 -07:00
Michel Weststrate
c902a27bce Add Sandy to internal documentation
Summary:
Scaffolded some internal Sandy notes and made them only internally available.

Since most of the pipeline was already set up by jknoxville, it is unclear to me if something needs to be done to set up the auto redirect from fbflipper.com

Reviewed By: jknoxville

Differential Revision: D22233534

fbshipit-source-id: 4bdf5535f5745e7e4d335647759c6cf1b7cc73c6
2020-07-01 09:12:36 -07:00