Skip to content

Conversation

@willcl-ark
Copy link
Contributor

Closes: #666

May not directly address:

Conclusion: the simplest route should probably be emphasized in the doc. Install Docker Desktop, create a Python venv, pip install warnet, warnet setup, done. Installing the deps globally can still be discussed but it should probably not be the default route when following the docs?

But I think the re-ordering should help significantly.

If we really want to address this comment, perhaps we should re-introduce warnet quickstart or something?

Copy link
Collaborator

@mplsgrant mplsgrant left a comment

Choose a reason for hiding this comment

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

This appears to address #666
ACK

@pinheadmz
Copy link
Contributor

pinheadmz commented Nov 13, 2024

LGTM - but considering the experience weve had thus far i think the very top of the page should look something like this:


TLDR

pip install warnet
warnet setup

@willcl-ark
Copy link
Contributor Author

willcl-ark commented Nov 13, 2024

LGTM - but considering the experience weve had thus far i think the very top of the page should look something like this:


TLDR


pip install warnet

warnet setup

I can add this section at the top if you're serious? I do agree it would be pretty nice myself...

(But I'd add venv create/activate too)

@willcl-ark
Copy link
Contributor Author

Hmmm as I sketch it out, I'm not sure a TLDR section is necessary with the new structure. And once we include a python venv, and a k8s cluster, we just end up repeating what is already in this change?

@pinheadmz
Copy link
Contributor

OK! ty <3

@pinheadmz pinheadmz merged commit 9829d18 into bitcoin-dev-project:main Nov 14, 2024
11 checks passed
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.

doc: reporting a couple confusions in dependencies installation

3 participants