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: Add Hello bitcoin Document. #142

Merged
merged 9 commits into from
Jan 25, 2024
Merged

feat: Add Hello bitcoin Document. #142

merged 9 commits into from
Jan 25, 2024

Conversation

nakul1010
Copy link
Contributor

@nakul1010 nakul1010 commented Jan 8, 2024

Closes #111
The PR adds the following

  • Update Hello World document

The DevStarter kit has been referenced in

  • HelloBitcoin document
  • Starter Project issue 95

Copy link

vercel bot commented Jan 8, 2024

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

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 24, 2024 6:04pm

@nakul1010
Copy link
Contributor Author

nakul1010 commented Jan 8, 2024

@nud3l it would be great if you could review the contract functions before I proceed to write the detailed documents. Just want to check if u are expecting any additional functionalities.

src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
src/hello-bitcoin/HelloBitcoin.sol Outdated Show resolved Hide resolved
@nakul1010 nakul1010 changed the title feat: Add Hello bitcoin contract. (WIP)feat: Add Hello bitcoin contract. Jan 16, 2024
@nud3l
Copy link
Contributor

nud3l commented Jan 16, 2024

@nakul1010 code LGTM, would be great to get the docs updated next. Thank you!

@nakul1010
Copy link
Contributor Author

nakul1010 commented Jan 18, 2024

@nud3l
I think the HelloBitcoin should be in another repo here are the issues I faced during building/deployment

  • The Bob repo already contains docs, multiple contracts and much more. As a smart contract, i would rather prefer an empty starter kit with only a hello world contract.
  • Keeping the Hello world in Bob doesn't exactly help new users,
    • no installation of bob-collective/bob is needed currently as HelloWorld in the same repo
    • multiple deployment scripts present
    • smart contract user continuously needs to maintain/upgrade a fork of bob-collective/bob
    • solidity version clashes between libraries if i create a new project with foundry
  • Currently coming to Bob as a developer feels like an info dump with lots of contracts and unnecessary code that is related to the main website.
  • As a dev, i would rather prefer a separate repo, from which I get the helloworld code, and basic installation setup done ie (bob-collective/bitcoin-spv/open Zepplin/account abstraction libraries installed with compatible solidity versions, scripts, and readme), and can carry forward my idea on building top of bob.

It will be a hassle maintaining 2 repos, but if we release tags it can be much simpler.

@nud3l
Copy link
Contributor

nud3l commented Jan 18, 2024

Excellent points, let's move this to a dedicated repo then @nakul1010 !

@nakul1010
Copy link
Contributor Author

Excellent points, let's move this to a dedicated repo then @nakul1010 !

Cool will keep this PR open, as it should just handle the documentation part.

@nakul1010 nakul1010 changed the title (WIP)feat: Add Hello bitcoin contract. feat: Add Hello bitcoin contract. Jan 22, 2024
@nakul1010 nakul1010 requested a review from nud3l January 22, 2024 10:18
@nakul1010 nakul1010 changed the title feat: Add Hello bitcoin contract. feat: Add Hello bitcoin Document. Jan 22, 2024
Copy link
Contributor

@nud3l nud3l left a comment

Choose a reason for hiding this comment

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

Some minor comments, but overall, LGTM!

docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
docs/docs/build/getting-started/helloworld.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@nud3l nud3l left a comment

Choose a reason for hiding this comment

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

Thanks!

@nud3l nud3l merged commit 2988614 into master Jan 25, 2024
3 checks passed
@nud3l nud3l deleted the nakul/feat_hello_bitcoin branch January 25, 2024 05:12
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.

Change hello world example to be Bitcoin specific
2 participants