docs(CSN-568): Update docs and README #282
Conversation
client --> web app --> validator --> miner
There was a problem hiding this comment.
First of all, please correct branch name. That format with (braces) is for commit messages and PR titles, branch names should follow more url/filename-friendly format as follows: docs/CSN-568-Update-main-README while title should in this case read docs(CSN-568): update docs and README (and perhaps a section of README should be contributors guide documenting things like these naming conventions so that it's easy to reference)
|
Also please take care of the merge conflicts |
There was a problem hiding this comment.
Please look into the areas I outlines in the individual comments. We should be be very careful with port opening instructions, that's the most common thing to misconfigure - good wording and examples around those parts should reduce the number of support requests significantly.
README.md
Outdated
| 1. **Install and configure `ufw`**: | ||
| ```bash | ||
| sudo apt install ufw | ||
| sudo ufw allow 4444 | ||
| sudo ufw allow 22/tcp | ||
| sudo ufw enable | ||
| sudo ufw status | ||
| ``` | ||
| You can open any custom range: `sudo ufw allow XXXX:YYYY/tcp` and use them as your `axon.port`. |
There was a problem hiding this comment.
This example should create working configuration if copy-pasted verbatim. Include example of open axon port (8091 is a good default I think) and change the comment to explain that 8091 can be changed to any port number as long as other configuration below is changed accordingly
| and [register the wallet to a netuid](https://github.com/opentensor/docs/blob/main/subnetworks/registration.md). | ||
| Once you have done so, you can run the miner and validator with the following commands. | ||
| ## Registering Your Hotkey | ||
| You need **$TAO** tokens in your coldkey to register the hotkey on the chosen netuid. |
There was a problem hiding this comment.
I believe there's some CLI to check exactly how much Tao is currently required for registration. It would be cool to see it here.
There was a problem hiding this comment.
btcli subnet lock-cost
There was a problem hiding this comment.
No, that's for creating a new subnet... The value required to burn for regi is in RECYCLE column in btcli subnet list (it can be optionally filtered with e.g. grep but I'd rather add a python script later to do it properly)
There was a problem hiding this comment.
thats right i forgot. thank you
README.md
Outdated
|
|
||
| ## Troubleshooting | ||
| - **No requests received (no ‘Challenge’ or ‘Specs’ events)**: | ||
| - Check your open ports (default 4444). |
There was a problem hiding this comment.
Axon port should be explicitly mentioned here (it's the most common support request, better be thorough with explanations). Also include a command that could be used to run this check (ufw open ports check command and how to get running miner CLI parameters - there should be the same port number which is the essence of "check your open ports").
README.md
Outdated
| - **Test**: `test` | ||
| - Or use a custom endpoint, e.g. `subvortex.info:9944` (recommended) | ||
| - **`--wallet.name`** & **`--wallet.hotkey`**: The coldkey/hotkey names you created. | ||
| - **`--axon.port`**: A port opened in your custom range as instructed above (e.g., 8091). |
There was a problem hiding this comment.
This is the first time this default value is mentioned, but I think it should be corrected above with future reference to this so that new user remembers it going forward.
|
Also #278 has a different take on the same instructions. I'd strongly prefer explanations, defaults, and examples were in sync in both documents - we don't want any dysfunction in case someone decides to mix and match and also automated script should produce the same result as copypasting default examples with clear explanations where things diverge. |
IvanAnishchuk
changed the title
No description provided.