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

feat(website): add tutorial document #412

Merged
merged 6 commits into from
Sep 22, 2022

Conversation

PainterPuppets
Copy link
Contributor

Description

  • Add a step-by-step tutorial to help newcomers understand how to use lomus.

Type of change

  • Documentation or Website

How Has This Been Tested?

  • Follow the document step-by-step to make a wallet

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules -->

@vercel
Copy link

vercel bot commented Sep 13, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
lumos-website ✅ Ready (Inspect) Visit Preview Sep 21, 2022 at 2:57PM (UTC)

@codecov
Copy link

codecov bot commented Sep 13, 2022

Codecov Report

Merging #412 (b0265d3) into develop (cc69d90) will increase coverage by 0.29%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #412      +/-   ##
===========================================
+ Coverage    81.98%   82.28%   +0.29%     
===========================================
  Files           93       95       +2     
  Lines        19105    19701     +596     
  Branches      1794     1863      +69     
===========================================
+ Hits         15664    16210     +546     
- Misses        3400     3437      +37     
- Partials        41       54      +13     
Impacted Files Coverage Δ
packages/debugger/src/executor.ts 97.40% <0.00%> (-2.60%) ⬇️
packages/codec/src/high-order/nested.ts 99.17% <0.00%> (-0.83%) ⬇️
packages/common-scripts/src/common.ts 87.37% <0.00%> (-0.52%) ⬇️
.../common-scripts/src/secp256k1_blake160_multisig.ts 79.45% <0.00%> (-0.16%) ⬇️
packages/debugger/src/download.ts 84.48% <0.00%> (ø)
packages/common-scripts/src/index.ts 100.00% <0.00%> (ø)
packages/config-manager/src/predefined.ts 100.00% <0.00%> (ø)
packages/helpers/src/address-to-script.ts 85.21% <0.00%> (ø)
packages/common-scripts/src/omnilock.ts 88.37% <0.00%> (ø)
packages/codec/src/error.ts 94.64% <0.00%> (ø)
... and 5 more

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 cc69d90...b0265d3. Read the comment docs.

website/docs/00-intro.md Outdated Show resolved Hide resolved
website/docs/00-intro.md Outdated Show resolved Hide resolved
website/docs/00-intro.md Outdated Show resolved Hide resolved
website/docs/00-intro.md Outdated Show resolved Hide resolved
Copy link
Contributor

@IronLu233 IronLu233 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "tell developer where the code in document should be placed" is very important. Should we explictly tell developer that "write these code to which file"

website/docs/00-intro.md Outdated Show resolved Hide resolved
website/docs/00-intro.md Outdated Show resolved Hide resolved
Comment on lines +44 to +46
``` shell
npm init
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
``` shell
npm init
```
``` shell
npm init

-y can skip input something for package info

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User may want to know what this parameter does if some parameters are added , but this is not really our business
The npm init is a nice experience for the user to create a project through some questions, we don't need to introduce this part of the complexity, if the user knows what they are doing then just go for it

```

``` shell
yarn init
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
yarn init
yarn init -y

website/docs/00-intro.md Outdated Show resolved Hide resolved
}
```

Congratulations! we write a function to get the balance of account, now we can call it to get our balances
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it missing a step to run

npx ts-node wallet.ts

?

:::

``` ts
console.log(`address: ${address}`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclear. As a noob, I want to ask, where should I put these two line code? Maybe I think I need to write it at the end of previous wallet.ts file

website/docs/00-intro.md Outdated Show resolved Hide resolved
Co-authored-by: Yonghui Lin <homura.dev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for newcomer
3 participants