search

bitcoin-dev-project / warnet

Monitor and analyze the emergent behaviors of Bitcoin networks
https://warnet.dev
MIT License
59 stars 27 forks source link

Clean up and update docs for v1.0 release #308

Open pinheadmz opened 2 months ago

Anyitechs commented 1 month ago

Hi @pinheadmz, I will like to work on the documentation. Can you provide more details on the issue?

pinheadmz commented 1 month ago

Hi @Anyitechs thanks for tuning in! I think the most changes have been in kubernetes deployment. See running.md for the current docs which are out of date. The commands we use now are in the /justfile and can either be documented explicitly or we can recommend installing https://github.com/casey/just

Besides this, having someone just read through the docs and try to do everything they describe to make sure the commands still work would be a huge help.

Anyitechs commented 1 month ago

Thank you for the response @pinheadmz. I've cloned the repo and going through it at the moment. I'll send in a PR draft asap.

Anyitechs commented 1 month ago

Hi @pinheadmz, I opened a draft PR here.

Let me know if there's anything I'm missing or needs to clean up.