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

documentation website setup #64

Merged
merged 10 commits into from
Mar 17, 2021
Merged

documentation website setup #64

merged 10 commits into from
Mar 17, 2021

Conversation

fuxingloh
Copy link
Contributor

@fuxingloh fuxingloh commented Mar 15, 2021

What kind of PR is this?:

/kind docs

What this PR does / why we need it:

Implements a documentation static website for jellyfish alongside the code. Currently, there are 3 main section of documentation. I used https://v2.docusaurus.io/ a static website generator powered by react + markdown. As markdown is how the content get created, the ssg used is quite a trival decision.

  1. Introduction - describing the project core.
  2. Testcontainers - what is testcontainers and how to use it for your project.
  3. Jellyfish - what is jellyfish and all the methods available

The docs structure:

docs/
├── jellyfish/
│   ├── api/
│   │   ├── mining.md
│   │   └── wallet.md
│   ├── overview.md
│   ├── design.md
│   └── usage.md
├── testcontainers/
│   ├── overview.md
│   └── usage.md
└── introduction.md

Which issue(s) does this PR fixes?:

Fixes #20

Additional comments?:

2 issues are created/separated to track the progress of website:

  1. documentation front matter #62 for the front matter improvement of the docs website
  2. documentation website continuous deployment #63 for CI/CD workflow of the website

This is how it looks like now for preview since, I have not created the workflow for automatic preview builds.

Light Mode Dark Mode
image image
image image
image image
image image

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

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%) 150 ms (+1.72% 🔺) 463 ms

@codecov
Copy link

codecov bot commented Mar 15, 2021

Codecov Report

Merging #64 (7f09b36) into main (89099f0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #64   +/-   ##
=======================================
  Coverage   93.85%   93.85%           
=======================================
  Files          14       14           
  Lines         244      244           
  Branches       29       29           
=======================================
  Hits          229      229           
  Misses         14       14           
  Partials        1        1           
Impacted Files Coverage Δ
packages/jellyfish-core/src/category/wallet.ts 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 89099f0...11535be. Read the comment docs.

@fuxingloh fuxingloh marked this pull request as ready for review March 15, 2021 08:57
@fuxingloh fuxingloh merged commit eaa4f6a into main Mar 17, 2021
@fuxingloh fuxingloh deleted the fuxingloh/docs branch March 17, 2021 04:54
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.

Documentations
3 participants