Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Steps in Getting Started documentation may break without getting noticed #734

Closed
DavidBruant opened this issue Mar 19, 2020 · 4 comments · Fixed by #885
Closed

Steps in Getting Started documentation may break without getting noticed #734

DavidBruant opened this issue Mar 19, 2020 · 4 comments · Fixed by #885
Assignees
Labels
agoric-cli package: agoric-cli documentation Improvements or additions to documentation tooling repo-wide infrastructure

Comments

@DavidBruant
Copy link
Contributor

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

@DavidBruant DavidBruant added documentation Improvements or additions to documentation agoric-cli package: agoric-cli tooling repo-wide infrastructure labels Mar 19, 2020
@DavidBruant DavidBruant changed the title Steps in agoric-cli documentation may break without getting noticed Steps in Getting Started documentation may break without getting noticed Mar 19, 2020
@katelynsills
Copy link
Contributor

This is a great idea. I'm adding this to the project board. Let's discuss and see if we can assign someone to this.

@DavidBruant DavidBruant self-assigned this Mar 22, 2020
@DavidBruant
Copy link
Contributor Author

The error i've seen in #735 is fixed, but i see a different one (something about exit not being defined on undefined)

This is blocking for me. If i cannot get getting started steps working for me, i cannot understand how zoe contracts work today, i cannot play with them, i cannot write one for non-fungible tokens

Also, if the getting started steps do not work for me, i imagine they won't for other people

I'm self-assigning

@katelynsills
Copy link
Contributor

This is blocking for me. If i cannot get getting started steps working for me, i cannot understand how zoe contracts work today, i cannot play with them, i cannot write one for non-fungible tokens

A potential way to get around the blocking issues - could you first write your Zoe contract in the Zoe packages, in the tests directory locally? That should allow you to understand how Zoe contracts work, play around with them, and write the non-fungible token contract

@DavidBruant
Copy link
Contributor Author

Sounds good, i'll try that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agoric-cli package: agoric-cli documentation Improvements or additions to documentation tooling repo-wide infrastructure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants