From b826a2ed205eef1cf95661ab88694ddd38e21801 Mon Sep 17 00:00:00 2001 From: Vasco Santos Date: Wed, 2 Dec 2020 15:41:09 +0100 Subject: [PATCH] chore: add js documentation contributing guidelines --- CONTRIBUTING_JS.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING_JS.md b/CONTRIBUTING_JS.md index 99e6944e..52fd04f8 100644 --- a/CONTRIBUTING_JS.md +++ b/CONTRIBUTING_JS.md @@ -144,7 +144,9 @@ For releasing a js-ipfs, see [RELEASE_ISSUE_TEMPLATE](https://github.com/ipfs/js #### Documentation -`TBW` +Documentation will be generated automatically by the JSDoc based TS types in the codebase. + +Type definitions and type imports should be created on the top of any JS file (below eventual requires needed). For tooling instructions and best practices, see [Documentation for JSDoc based TS types](https://github.com/ipfs/aegir/blob/master/md/ts-jsdoc.md). ### Commits