Giters

OpenMined / syft.js

The official Syft worker for Web and Node, built in Javascript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Create an auto-generated API reference documentation

cereallarceny opened this issue · comments

commented

Where?

The entire project

Who?

Developers looking to implement the library in their application.

What?

We want to provide automatically generated API reference documentation to allow developers to use our library in their application to be able to read all publicly available methods and their signatures. This documentation is purely meant to be functional. It does not need to look pretty, but it does need to be very organized. Here is an example of what you should aim to reproduce.

Additional Context

  • Generate this file to the root of the project located at /API-REFERENCE.md
  • Set it to run the regeneration function on every commit and add it to the current commit
  • Add a reference to this file from the Usage section of the main readme