Skip to content

Fn FDK Documentation Guidelines

Michael J Williams edited this page Mar 13, 2019 · 6 revisions

When developing documentation for the Fn FDKs, what documentation goes into the FDK repo and what goes into the general docs repo?

Docs on FDK Development - FDK Repo

Docs stored here should cover how to develop an FDK for Fn. Any articles, tutorials, examples, or notes that pertain to that specific topic stay in the FDK repo.

Example: An article describing the APIs required to implement an Fn FDK.

Docs on using an FDK - Docs Repo

Documents describing the development of Fn functions using the FDK should go in the docs repository. Usage oriented content should go here.

Example: An article on setting up a development environment to create Fn functions that use an FDK.