chore(docs): fix docs and mark some as deprecated #1754
Conversation
vpavlin
requested review from
jm-clius,
alrevuelta and
Ivansete-status
and removed request for
jm-clius
docs/contributors/waku-fleets.md
Outdated
| @@ -20,8 +20,7 @@ and configured to bridge toy-chat messages to the `#waku channel` on the Vac Dis | |||
|
|
|||
| ### Fleet deployment rationale | |||
|
|
|||
| The `test` fleet is automatically updated after every commit to the `nim-waku` `master` branch | |||
| and is therefore the most up to date representation of Waku v2 development. | |||
| The `test` fleet is automatically updated after every commit to the `nim-waku` repository `master` branch and is therefore the most up to date representation of Waku v2 development. | |||
There was a problem hiding this comment.
| The `test` fleet is automatically updated after every commit to the `nim-waku` repository `master` branch and is therefore the most up to date representation of Waku v2 development. | |
| The `test` fleet is automatically updated after every commit to the `nwaku` repository `master` branch and is therefore the most up to date representation of Waku v2 development. |
There was a problem hiding this comment.
Yeah, nim-waku is all over the place. I would say we can run the *.md files through sed 's/nim-waku/nwaku/g in a follow up PR?
There was a problem hiding this comment.
So, actually we cannot do a simple sed as it would completely mess up references to CI and docker images:D
I fixed the references in the waku-fleets.md and checked a few other files, but seems that it was mainly the fleet doc which was incorrectly referencing nim-waku
docs/tutorial/filter.md
Outdated
| > TODO: Fix or depricate | ||
|
|
There was a problem hiding this comment.
No strong opinion here, but perhaps we can just add the date and a note to say that this refers to an older version of nwaku and direct people to the operator guide? I think we may want to keep the record of old testnets and tutorials, though I'm open to just deleting these from the repo as well.
There was a problem hiding this comment.
I added the date, but kept the TODO. We can do something about those later
| ## Interactively add a node | ||
|
|
||
| There is also an interactive mode. Type `/connect` then paste address of other node. However, this currently has some timing issues with mesh not being updated, so it is adviced not to use this until this has been addressed. See https://github.com/status-im/nim-waku/issues/231 | ||
| There is also an interactive mode. Type `/connect` then paste address of other node. However, this currently has some timing issues with mesh not being updated, so it is adviced not to use this until this has been addressed. See https://github.com/waku-org/nwaku/issues/231 |
There was a problem hiding this comment.
I wonder if we could remove this section as the issue #231 is closed. In that issue it is said that we already have 'staticnode' option.
Maybe it worth opening a separate issue to clean the /connect option if it doesn't work as expected and won't be used. So maybe we could add another TODO: deprecate or fix ;P
wdyt @jm-clius ?
There was a problem hiding this comment.
Right. Thanks! I don't think we have to spend too much time maintaining docs for previous testnets, although it would be a good idea to indicate that this relates to a (past) testnet for a previous version of nwaku. That said, afaik this issue has been fixed though I haven't used it in a while to confirm. :)
Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com>
Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com>
Description
First of all, sorry for a lot of changes in a single PR, but once I started...
I went through the
docs/folder and fixed links to repo(s) and CI. I also fixed the doc factually in a few cases and marked some withTODO: Depricate or fixto get your opinion since they are no longer useful/workingChanges
status-im/nim-waku->waku-ord/nwaku(no entirely necessary as Github will redirect, but it looks better from contributor/user perspective if the doc is not obviously outdated:) )