Documentation - Githubissues

MatrixAI / js-encryptedfs

Encrypted Filesystem for TypeScript/JavaScript Applications

https://polykey.com

Apache License 2.0

10 stars 3 forks source link

Documentation #20

Closed robert-cronin closed 4 years ago

robert-cronin commented 4 years ago

Documentation needs to be created and should include:

Overview (explanation of upper and lower directory/chunks etc)
Installation
Usage
Warnings (e.g. for usage of context control actions like chdir and setuid etc.)

This can go into README.md

robert-cronin commented 4 years ago

Function docs also need to be implemented. A draft of both function documentation and the README.md are a part of PR #19

CMCDragonkai commented 4 years ago

API docs should be autogenerated. We used jsdocs or something back in js-virtualfs. But we can do something different with something designed for typescript.

CMCDragonkai commented 4 years ago

As for usage. Keep it light, README.md should be fine. Since we are just saying it works like node fs, but encrypted.

robert-cronin commented 4 years ago

Yes there is typedoc I have added this as a separate commit because I think its noteworthy. Documentation looks quite good and we can host it on github pages. Once you merge #19 I will publish it to github pages :+1: