Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup documentations #86

Merged
merged 7 commits into from
Mar 29, 2021
Merged

cleanup documentations #86

merged 7 commits into from
Mar 29, 2021

Conversation

fuxingloh
Copy link
Contributor

@fuxingloh fuxingloh commented Mar 27, 2021

What kind of PR is this?:

/kind docs

What this PR does / why we need it:

Currently the front matter of the website is missing:

  1. Logo
  2. Branding & Copies
  3. SEO Meta
  4. SEO Optimized sharable page/content
  5. Netlify SSO Plan requirement

This PR adds and implements all those required.

Additionally, severals improvements had been mad for docs.

  1. /docs/testcontainers is separated into it's only docs category.
  2. /docs/jellyfish is simplified and merged into one category.
  3. A top section of each API indicates what the category is and how to access it.
  4. A very clear interfaces/protocols to define the API contract is included for each RPC.

Which issue(s) does this PR fixes?:

Fixes #62

Additional comments?:

  • Updated all npm description in package.json to use DeFi Blockchain keyword
  • Added a WIP masthead on top of the docs website.

@netlify
Copy link

netlify bot commented Mar 27, 2021

Deploy preview for jellyfish-defi ready!

Built with commit 9020d38

https://deploy-preview-86--jellyfish-defi.netlify.app

@defichain-bot defichain-bot added the kind/docs Non feature documentation change label Mar 27, 2021
@github-actions
Copy link

github-actions bot commented Mar 27, 2021

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
packages/jellyfish/dist/jellyfish.umd.js 15.66 KB (0%) 314 ms (0%) 135 ms (-2.04% 🔽) 448 ms

@codecov
Copy link

codecov bot commented Mar 27, 2021

Codecov Report

Merging #86 (9020d38) into main (56aa664) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #86   +/-   ##
=======================================
  Coverage   93.30%   93.30%           
=======================================
  Files          15       15           
  Lines         254      254           
  Branches       30       30           
=======================================
  Hits          237      237           
  Misses         15       15           
  Partials        2        2           
Impacted Files Coverage Δ
...ish-api-core/__tests__/container_adapter_client.ts 100.00% <ø> (ø)
packages/jellyfish-api-core/src/category/mining.ts 100.00% <ø> (ø)
packages/jellyfish-api-core/src/category/wallet.ts 100.00% <ø> (ø)
packages/jellyfish-api-jsonrpc/src/index.ts 96.77% <ø> (ø)
packages/jellyfish-json/src/index.ts 90.00% <ø> (ø)
packages/jellyfish-api-core/src/index.ts 100.00% <100.00%> (ø)
packages/jellyfish/src/jellyfish.ts 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1e1a09e...9020d38. Read the comment docs.

@fuxingloh fuxingloh changed the title Cleanup documentations cleanup documentations Mar 27, 2021
@fuxingloh fuxingloh marked this pull request as ready for review March 29, 2021 02:34
@fuxingloh fuxingloh requested a review from thedoublejay March 29, 2021 02:35
@fuxingloh fuxingloh merged commit 3e7b15e into main Mar 29, 2021
@fuxingloh fuxingloh deleted the fuxingloh/documentations branch March 29, 2021 04:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Non feature documentation change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

documentation front matter
3 participants