search

WhiteflagProtocol / whiteflag-api

Reference implementation of the Whiteflag protocol in Node.js that acts as an API to connect applications with the underlying blockchains
https://api.whiteflagprotocol.org
Other
4 stars 5 forks source link

Fully document the software structure, implementation and interfaces #6

Closed ts5746 closed 4 years ago

ts5746 commented 5 years ago

The project should have, at a minimum, the following documented:

  1. its internal structure
  2. the public interface
  3. the installation and usage guidelines
  4. its implementation-specific protocol behaviour
ts5746 commented 5 years ago

Pt. 2. Public Interface documentation update: The API definition for the public interface is now documented in static/openapi.json in accordance with the OpenAPI specification. The index.html uses a stand-alone JavaScript version of Redoc to render the API definition into a human readable webpage.

ts5746 commented 5 years ago

Pt. 1. Internal Structure documentation update: Internal structure and workings are being documented in the markdown files in doc/.

ts5746 commented 4 years ago

Pt.1. Now documented in code with JSDoc, from which the source code documentation in docs/ is generated. See also CONTRIBUTING.md. Together with the already available descriptions and the OpenAPI definition, this is available as a Github Page. Pt. 2. See above. Pt. 3. Included in the README.md, LICENSE.md and in docs/installation.md. Pt. 4. Included in docs/protocol.md and also SCOPE.md.