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

Improve documentation (Closes #14 and Closes #15) #17

Merged
merged 7 commits into from
Mar 18, 2021
Merged

Conversation

rmeissner
Copy link
Contributor

@rmeissner rmeissner commented Mar 17, 2021

@rmeissner rmeissner changed the title Some clean up Improve documentation (Closes #14 and Closes #15) Mar 17, 2021
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved
Copy link
Contributor

@fedgiac fedgiac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code changes look reasonable and the extra information to the readme is helpful.
I'd explain more clearly however what SafeSnap is and how it relates to the DAO module.

docs/setup_guide.md Outdated Show resolved Hide resolved
docs/setup_guide.md Outdated Show resolved Hide resolved

![Transactions preview](./snapshot_plugin_preview.png)

Once the proposal has been resolved it is possible to use the plugin to submit the proposal to the DAO module via the plugin.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plugin is the same, right?

Suggested change
Once the proposal has been resolved it is possible to use the plugin to submit the proposal to the DAO module via the plugin.
Once the proposal has been resolved it is possible to submit the proposal to the DAO module via the newly added plugin.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave out newly added as this step normally happens after the proposal has been resolved (so 7 days later :D)

Comment on lines +1 to +5
# SafeSnap Setup Guide

This guide shows how to setup the DAO module with a Gnosis Safe on the Rinkeby testnetwork. It will use [Realitio](https://realit.io/) and can be used with [Snapshot](https://snapshot.org/).

For more information on SafeSnap please refer to the [Gnosis blog](https://blog.gnosis.pm/ea67eb95c34f).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand SafeSnap to be the name for the entire concept/infrastructure (frontend/backend/contract) allowing users in a DAO to execute successful proposals onchain. I think this should be stated somewhere in the main readme, since I came here with the intention of Follow our [setup guide](./docs/setup_guide.md) to get started with the DAO module but I got a guide that explains how to set up a mysterious SafeSnap.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I can see why the naming is a little confusing.
SafeSnap is the name of the specific configuration using a Gnosis Safe, the dao module, and the corresponding Snapshot plugin. We should probably make that more explicit in the link from the readme.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I adjusted the link in the readme to make this more clear

docs/setup_guide.md Outdated Show resolved Hide resolved
@rmeissner rmeissner merged commit a044379 into main Mar 18, 2021
@rmeissner rmeissner deleted the feature/clean_up branch March 18, 2021 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants