Commit Graph
368 Commits
Author SHA1 Message Date
Travis CI e4b6e3ef3d [CI Skip] 0.31.34 2018-10-13 19:07:03 +00:00
Travis CI 249fc20742 [CI Skip] 0.31.33 2018-10-13 16:06:28 +00:00
Travis CI 49cbfa8c8b [CI Skip] 0.31.32 2018-10-13 15:55:21 +00:00
Travis CI 3ab383f3ec [CI Skip] 0.31.31 2018-10-13 15:38:10 +00:00
Travis CI 75e800374f [CI Skip] 0.31.30 2018-10-13 14:43:43 +00:00
Luke Schoen 68f5ac27ed docs: Relates to #268. Add Polkadot white logo. Match styles to apps (#277)
* 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
2018-10-13 16:38:29 +02:00
Travis CI 57b481f7d4 [CI Skip] 0.31.29 2018-10-13 14:36:12 +00:00
Travis CI 8c639f3214 [CI Skip] 0.31.28 2018-10-13 07:01:00 +00:00
Travis CI 1dd3cfce88 [CI Skip] 0.31.27 2018-10-12 19:58:51 +00:00
Travis CI 543c2af377 [CI Skip] 0.31.26 2018-10-12 19:20:20 +00:00
Luke Schoen 4748e8c87f docs: Relates to #193. Generate Substrate Interface methods in API docs for RPC, Storage, and Extrinsics from Metadata (#265)
* 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
2018-10-12 21:15:01 +02:00
Travis CI b4f309584d [CI Skip] 0.31.25 2018-10-12 16:04:53 +00:00
Travis CI 15ed626e2e [CI Skip] 0.31.24 2018-10-12 15:46:26 +00:00
Travis CI 630b7a037d [CI Skip] 0.31.23 2018-10-12 15:38:19 +00:00
Travis CI e01b432350 [CI Skip] 0.31.22 2018-10-12 14:50:57 +00:00
Travis CI b913ace9be [CI Skip] 0.31.21 2018-10-12 13:44:40 +00:00
Travis CI 1a4d60efcb [CI Skip] 0.31.20 2018-10-12 12:57:08 +00:00
Travis CI 5e0967063b [CI Skip] 0.31.19 2018-10-12 12:52:03 +00:00
Travis CI eb5fbad5aa [CI Skip] 0.31.18 2018-10-12 10:37:48 +00:00
Travis CI dc5802abe4 [CI Skip] 0.31.17 2018-10-12 09:24:33 +00:00
Travis CI d870b54d8d [CI Skip] 0.31.16 2018-10-12 07:40:11 +00:00
Travis CI 0f64f90d40 [CI Skip] 0.31.15 2018-10-11 19:40:47 +00:00
Travis CI a14fff7c3c [CI Skip] 0.31.14 2018-10-11 19:33:22 +00:00
Travis CI eba79f160a [CI Skip] 0.31.13 2018-10-11 19:01:37 +00:00
Travis CI 83f63e5adf [CI Skip] 0.31.12 2018-10-11 16:52:22 +00:00
Travis CI 4be4d8004f [CI Skip] 0.31.11 2018-10-11 13:31:50 +00:00
Travis CI 35115723e1 [CI Skip] 0.31.10 2018-10-11 11:43:54 +00:00
Travis CI e409be6dbd [CI Skip] 0.31.9 2018-10-11 10:04:35 +00:00
Travis CI e915474763 [CI Skip] 0.31.8 2018-10-11 08:25:22 +00:00
Travis CI 05da1ee8c8 [CI Skip] 0.31.7 2018-10-11 07:38:36 +00:00
Travis CI b96f35fcd4 [CI Skip] 0.31.6 2018-10-11 05:41:50 +00:00
Travis CI 9e2962f0c5 [CI Skip] 0.31.5 2018-10-10 21:36:12 +00:00
Travis CI a9c195bf1e [CI Skip] 0.31.4 2018-10-10 18:23:34 +00:00
Travis CI c30c66e2de [CI Skip] 0.31.3 2018-10-10 18:15:38 +00:00
Travis CI 8e9243fdd6 [CI Skip] 0.31.2 2018-10-10 11:21:11 +00:00
Luke Schoen bba764bd28 feat: Fixes #210. Add Mermaid.js Gitbook plugin. Generate API flow diagram (#211)
* feat: Add Mermaid.js Gitbook plugin. Generate API flow diagram

* fix: Remove HTTP from diagram. Change text to funnel user to WS
2018-10-10 13:16:36 +02:00
Travis CI af10c69d2b [CI Skip] 0.31.1 2018-10-10 08:05:35 +00:00
Jaco Greeff 4344f33de8 First stage renames, rpc-{core,provider,rx} (#220)
* Docs renames (& removal for re-gen)

* Rename api, api-provider & api-rx

* Apoi -> Rpc, RxApi -> RpcRx (classes)

* Add .nodoc

* Bump version

* Link updates (summary)

* Cleanup deleted (master version)

* Deleted re-instated

* More... ;)

* Types...

* Revert .nodoc
2018-10-10 10:01:34 +02:00
Travis CI cd7c17b265 [CI Skip] 0.30.45 2018-10-10 07:31:35 +00:00
Travis CI 2127964f9a [CI Skip] 0.30.44 2018-10-09 15:49:18 +00:00
Travis CI 84ef15159c [CI Skip] 0.30.43 2018-10-09 14:30:26 +00:00
Travis CI 2c1693277a [CI Skip] 0.30.42 2018-10-09 14:03:43 +00:00
Travis CI 1263e5fb65 [CI Skip] 0.30.41 2018-10-09 12:12:39 +00:00
Travis CI 4986897de9 [CI Skip] 0.30.40 2018-10-09 11:00:05 +00:00
Travis CI 6b7cd3211b [CI Skip] 0.30.39 2018-10-09 09:16:41 +00:00
Travis CI 0861c3e374 [CI Skip] 0.30.38 2018-10-08 14:01:03 +00:00
Travis CI 70ea6e0d3c [CI Skip] 0.30.37 2018-10-08 13:51:45 +00:00
Travis CI 6661cc1b81 [CI Skip] 0.30.36 2018-10-08 12:07:45 +00:00
Travis CI 8a403c38eb [CI Skip] 0.30.35 2018-10-08 10:40:27 +00:00
Travis CI 1998e74683 [CI Skip] 0.30.34 2018-10-08 10:21:33 +00:00