Improve TypeDoc by improving the layout and adding some comments #541
Conversation
package.json
Outdated
| @@ -22,7 +22,8 @@ | |||
| "mustache": "^4.0.0", | |||
| "node-fetch": "^2.6.1", | |||
| "text-encoding-utf-8": "^1.0.2", | |||
| "tweetnacl": "^1.0.1" | |||
| "tweetnacl": "^1.0.1", | |||
| "typedoc-neo-theme": "^1.1.0" | |||
There was a problem hiding this comment.
@mehtaphysical this should be in devDependencies together with typedoc
src/connect.ts
Outdated
| * | ||
| * To sign transactions you can also pass: | ||
| * 1. {@link ConnectConfig.keyStore} | ||
| * 2. {@link ConnectConfig.deps | ConnectConfig.deps.keyStore} |
There was a problem hiding this comment.
let's just skip deps from the docs, it should be deprecated
src/browser-connect.ts
Outdated
| * | ||
| * To sign transactions you can also pass: | ||
| * 1. {@link ConnectConfig.keyStore} | ||
| * 2. {@link ConnectConfig.deps | ConnectConfig.deps.keyStore} |
There was a problem hiding this comment.
let's just skip deps from the docs, it should be deprecated
There was a problem hiding this comment.
@mehtaphysical looks good to me, but need to fix minor issues with devDependencies and deps
src/connect.ts
Outdated
| @@ -47,16 +46,29 @@ export async function connect(config: ConnectConfig): Promise<Near> { | |||
| // TODO: Only load key if network ID matches | |||
| const keyPair = accountKeyFile[1]; | |||
| const keyPathStore = new InMemoryKeyStore(); | |||
| await keyPathStore.setKey(config.networkId, accountKeyFile[0], keyPair); | |||
| await keyPathStore.setKey( | |||
There was a problem hiding this comment.
nit: feels like this and following reformatting isn't related to content of PR (generally best avoid making unnecessary changes to not mess with git blame) + seems to use vertical space a bit too agressively
|
conflicts fixed. Can i merge this? |
|
Awesome work, merging. This is exactly what we need to do for |
This PR adds comments and updates the TypeDoc dependency to improve the generated documentation. Contributes to #483.
It also bring in the typedoc-neo-theme which helps improve readability of the generated docs. We are a bit blocked by this outstanding issue: google/typedoc-neo-theme#67.
Here is a link to a preview: http://dweb.link/ipfs/QmenzPfZTuS17LHYCYsiFFFC855xBG8xzqzCYUHtXi8Pnf