Steps in Getting Started documentation may break without getting noticed #734
Labels
agoric-cli
package: agoric-cli
documentation
Improvements or additions to documentation
tooling
repo-wide infrastructure
Problem
I've performed the current getting started steps
I've come across an error at
agoric deploy
I'm not the only one and it's not the first time. Given agoric-cli depends on pretty much every (?!) package of agoric-sdk, i'm inclined to think that it will happen again. But since the steps described in the doc are in the doc, there is no way to know they have broken
This will result in a frustrating developer experience i imagine
Potential solutions
Write automated tests for what's in the doc
This way, if the tests pass, it should give strong assurance that the doc document something that works as expected
And fix things so the tests pass otherwise
The text was updated successfully, but these errors were encountered: