* refactor: Related #323. Try moving Gitbook logo generator into devDependencies
* refactor: Move all Gitbook plugins to devDependencies incl. babel plugin resolver
* fix: Manual alphabetical ordering for Storage Substrate methods
* fix: Fixes#288. Alphabetical ordering for Sections and Methds of RPC, Storage, Extrinsics
* refactor: Move alphabetical sorting of Methods in Extrinsics Section into separate function
* refactor: Use localeCompare to sort more concisely
* fix: Fixes#289. Add Anchor links to Sections on Node interfaces pages RPC, Storage, Extrinsics
* refactor: Add reusable functions to generate section links/header. Add constants for back to top link/anchor
* Add function with switch to generate section links to section anchors.
* Add common function to generate section header.
* Reuse common Anchor/Link HTML with constants.
* refactor: Rename generateAnchors to generateSectionLinks. Add reusable function for section link text
* docs: Relates to #268. Add Polkadot white logo. Match styles to apps
* fix: Change logo url for plugin to production link
* fix: Remove Polkadot logo
* feat: Add Polkadot-js logo
* fix: Adjust styles for Polkadot-js logo
* docs: Relates to #193. Generate Methods in API docs to Substrate Interfaces Extrinsics and Storage from Metadata
* Steps to generate Gitbook:
```
yarn run build:methodsdoc;
yarn run build;
yarn gitbook serve;
```
* Allows generating a docs/METHODS_STORAGE.md and docs/METHODS_EXTRINSICS.md files by running `yarn run build:methodsdoc`
* Note: The script runs `node packages/types/src/MetadataMdWrapper.js`, which uses Babel.js to transpile the TypeScript file MetadataMd.ts into JavaScript as MetadataMd.js by using the babel-plugin-module-resolver dependency that has been added to package.json. It runs MetadataMd.js, which parses a hard-coded copy of a Metadata response from the Substrate Node, and then generates the two aforementioned Markdown files to be included in the Gitbook.
* Important Note: DO NOT run `./node_modules/.bin/tsc packages/types/src/MetadataMd.ts; node packages/types/src/MetadataMd.js;`, as doing so may incorrectly transpile other TypeScript files, and will give errors like `TypeError: bn_js_1.default is not a constructor` when you run your unit tests.
* Added links that work when you go to http://localhost:4000/api/ and click the "api" link on the side menu
* Note: This was achieved by first adding the links in packages/api/README.md (i.e. `[Extrinsics (Substrate Interface)](../METHODS_EXTRINSICS.md)`). Note that the links could also be `METHODS_EXTRINSICS.html` and it would still work. It is VERY important to add links to these Markdown files in docs/SUMMARY.md (i.e. `[Storage](METHODS_STORAGE.md)`), as Gitbook generates HTML files in the same docs/ directory (i.e. it generates docs/METHODS_STORAGE.html) for any links provided in that file, and when you run `yarn run build; yarn gitbook serve` it will put a copy of those HTML files in the _book directory so it can be accessed in the browser.
* Replaces PR #249 and #255 from jg-meta-md from jg-meta-md-luke branches
* feat: Add script to generate decoded JSON file of the Metadata. Remove test.
* Summary:
* Running `yarn run build:decodedjson` will generate packages/types/src/Metadata.decoded.json from the Metadata in the Metadata.rpc.ts file.
* docs: Manually add RPC Substrate Interface API docs including author, chain, state, system
* docs: Append Storage Substrate methods to Storage Methods. Add consistent styling. Add descriptions
* Add Description at top of Substrate Interface page for RPC, Extrinsics, and Storage in API docs
* Add styling to Substrate Interface page for Extrinsics and Storage, including:
* ▸ symbol before each method
* bold method names
* adding Summary label and only showing the summary label if a summary exists
* adding a horizonal line between each section of methods
* Fix by adding new line after description when there is one in Extrinscis and Storage
* Manually creating a markdown file containing storage.substrate methods METHODS_STORAGE_SUBSTRATE.md, and then reading from the file and appending it to the bottom of the METHODS_STORAGE.md file that is generated, since the storage.substrate methods are not available from the Metadata.
* Fix by reading and writing to file using UTF8 instead of ASCII so symbols appear correctly
* Updating docs/METHODS_RPC.md and adding a horizontal line before the first section of methods
* docs: Fix Readme file step numbering
* docs: Generate the Substrate Interface Markdown files first when run yarn run build
* refactor: Move babel register config into shared file
* refactor: Use shared function to overcome codeclimate error
* fix: Reword description of RPC methodsto address review comment
* docs: Rename to Runtime Node Interfaces to address review comment
* docs: Rename to Runtime Node Interface in api Readme to address review comment
* docs: Fix minor typos
* docs: Fixes#117 providing Readme ref to jsonrpc docs
* fix: Remove preceding whitespace
* docs: Rename so RPC is not referred to as an interface of the runtime
* docs: Refer to Storage Substrate methods as always available to runtime implementation
* test: Restore the test that was unnecessary deleted
* Move scripts into packages/types/src/scripts
* docs: Add script to generate RPC interface docs
* fix: Fix TSlint error where element had any time due to no index signature
* refactor: Restore code back to normal instead of bowing to codeclimate whims
* refactor: Declare meaningful variables to make more readable
* docs: Show .subscribe when it is isSubscription method
* fix: Fixes#221. Exclude tests files in build directory. Only use those in src
* See modulePathIgnorePatterns: https://jestjs.io/docs/en/configuration.html#modulepathignorepatterns-array-string
* fix: Update modulePathIgnorePatterns to cater for renamed packages
* Update modulePathIgnorePatterns to match renaming that occurred in PR #220
* test: Add build directory of api/rx to Jest config of modulePathIgnorePatterns
* fix: Remove docs/api since replaced with docs/rpc-core
* fix: Remove docs/api-provider since replaced with docs/rpc-provider
* fix: Remove docs/api-rx since replaced with docs/rpc-rx
* fix: Remove the guide file that serves no purpose
* fix: Change license from ui-observable to api-observable
* fix: Remove disused mockHttp and mockWs that are duplicates of those in rpc-provider
* fix: Clarifies difference between PropIndex and ProposalIndex from Issue #226
* fix: Update api-observable Readme to refer to rpc-core, previously called api
* misc: Update Readme of rpc-core. See commit message details.
* Update name to be @polkadot/rpc-core instead of @polkadot/api
* Use Yarn instead of NPM for instructions adding dependencies
* Refer to @polkadot/rpc-core as `Rpc`
* Highlight that given block header hash should be a 0x-prefixed hex string with length of 64 (not only length of 10 as shown in the example)
* Showcase more information that you can obtain from the header object (i.e. best block number, parentHash, stateRoot, extrinsicsRoot, and digest)
* Use `header.raw` instead of just `header` to access properties of the header object
* Update the example to console.log the subscription ID
* Add missing semicolon
* fix: Fix name in license header and rename Api to Rpc for rpc-core e2e tests
* fix: Update rpc-provider Readme to use Yarn instead of NPM install
* fix: Fix minor typo
* fix: Rename Api to Rpc for rpc-provider ws
* fix: Refer to rpc-core instead of api in the rpc-rx Readme
* fix: Update rpc-rx files to refer to it as RpcRx instead of RxApi or just Api
* fix: Refer to rpc-core as Rpc instead of Api
* fix: Update type-jsonrpc Readme. Fix typo. Use Yarn not NPM. Refer to TSLint not Flow
* refactor: Move non-type dependency import with non-type dependencies
* docs: Add link to parity-codec repo
* fix: Avoid use of .raw. Fix listen to blocks example
* fix: Add missing error to newHead in listen to blocks example
* fix: Fixes#204. Adds coloured syntax highlighting to TypeDoc code examples
* Add Gitbook plugin Sunlight Highlighter https://www.npmjs.com/package/gitbook-plugin-sunlight-highlighter
* Still requires use of <BR> HTML element to shift code onto a new line
* Example use of Sunlight Highlighter from their README `javascript+theme:gitbook+lineNumbers:true+lineNumberStart:100` (in this example it uses their gitbook theme with line numbers shown and line numbers starting from 100)
* Updated book.json to add the Sunlight Highlighter plugin, and explicitely configured it to use the gitbook theme by default
* Enable showing line numbers only on TypeDoc example code that is longer (i.e. 8 lines long)
* fix: Remove unnecessary inline config for no line numbers since is default
* fix: Remove use of line numbers so consistent with the rest
* fix: Modify TypeDocs that change the source to resolve rendering correctly
* Add TypeDoc/TSDoc labels
* Use HTML <BR> element in TypeDoc to generate new lines even to achieve a newline between lines of code
* Use HTML <PRE><CODE> combination in TypeDoc for multiple line code generation
* Add missing TypeDocs for HTTP `constructor` and `send` for HTTP and WS
* Remove unnecessary assignment of `= true` default value in TypeDoc @param value and clean up text alignment
* Verified that it displays correctly in development environment by running `yarn; yarn polkadot-dev-build-docs; yarn gitbook serve`, and then navigating to localhost:4000
* fix: remove signature that was used with jsdocs flowtype
* Move triple backticks onto new line so it doesn't break the code snippet formatting
* Add newline between dependency imports and variable declarations
* Add link to relevant line of Github repo of eventemitter3 instead of the travis build directory
* Add full stop at end of sentence in line before `@example` in .ts files, since I noticed that was the only difference between code snippet in docs that was being rendered correctly and one that was not (if the docs were generated from it). Not sure if this actually makes any difference though, but it doesn't hurt to try. i.e. change `[[unsubscribe]]` to `[[unsubscribe]].`
* Add missing code syntax for `new Ws(defaults.WS_URL)`
* Add missing `*__example__*:`
* Add missing semi-colons throughout code
* Fix typos and some grammar
* Move import of external libraries i.e. `const BN = require('bn.js');` or `const crypto = require('crypto');` before `@polkadot` ones in code
* Change from `e` to `error` in catch blocks for readable documentation
Luke Schoen