Make sure tutorial will work for user#173
Conversation
Sometimes the user is using a different library version. I tested this tutorial many times before finding the right working version. It's good to have the version explicit in the docs.
✅ Deploy Preview for libp2p-docs-mirror ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
salmad3
added
change request
|
@danicuki checking here if you're okay with the suggestions |
Co-authored-by: Danny Salman <salman.danny03@hotmail.com>
Co-authored-by: Danny Salman <salman.danny03@hotmail.com>
|
yes! thanks! |
marten-seemann
left a comment
marten-seemann
left a comment
There was a problem hiding this comment.
Putting version numbers here is a guarantee that we'll have a horribly outdated tutorial in a few months.
we did mention that we'd setup jobs in the CI/CD to run the published tutorials which would notify of version changes or breaks. Or, if they are already running against the examples on each repo, we can pull in those updates |
A set of versions that work once won't break. That doesn't prevent them from becoming outdated though. |
|
I've added the version with the purpose of helping the developer to make it work. Because, I was one that suffered trying to make it work and had to discover the right version. You are right: doc gets outdated. The point is, it will get outdated even if we don't put any version in the tutorial. So we must keep it updated anyway. The version here has the purpose of making at least work, even when it is outdated :-) |
|
with the stale nature of this change request and in correspondence with: #235, lets close this. |
4 participants
Sometimes the user is using a different library version. I tested this tutorial many times before finding the right working version.
It's good to have the version explicit in the docs.