Skip to content

add hat tree linking language + minor fixes#100

Open
more-reese wants to merge 2 commits into
Hats-Protocol:developfrom
more-reese:develop
Open

add hat tree linking language + minor fixes#100
more-reese wants to merge 2 commits into
Hats-Protocol:developfrom
more-reese:develop

Conversation

@more-reese
Copy link
Copy Markdown

  • Update language in Hat Tree linking section to reflect David's feedback in moreReese<>Hats telegram group (sent 23 February 2023)
  • Fix broken internal links to section headers

Comment thread user_guide/user_guide.md
# Hat Tree linking
This powerful feature lets you graft two trees together, by linking the Top Hat from one tree to a hat from another tree.

When this happens, as seen in the diagram, the level 2 hat from Tree 1 becomes the admin for the Top Hat of tree 2, and therefore the Top Hat of Tree 2 effectively becomes a level 3 hat in Tree 1. The previous Top Hat from the now nonexistent Tree 2 will then hold the same properties as as any other hat in Tree 1, with one distinction: the Top Hat and its child hats can be unlinked from Tree 1 at any point in the future, thereby returning back to the initial state of having two separate hats trees.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
When this happens, as seen in the diagram, the level 2 hat from Tree 1 becomes the admin for the Top Hat of tree 2, and therefore the Top Hat of Tree 2 effectively becomes a level 3 hat in Tree 1. The previous Top Hat from the now nonexistent Tree 2 will then hold the same properties as as any other hat in Tree 1, with one distinction: the Top Hat and its child hats can be unlinked from Tree 1 at any point in the future, thereby returning back to the initial state of having two separate hats trees.

Comment thread user_guide/user_guide.md

<img src=./assets/hatTreeLinking2.png width="600" height="350">

If approved, Hat Tree 2 links, or "grafts", to Hat Tree 1. The approving hat becomes the admin hat the Top Hat from Hat Tree 2.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
If approved, Hat Tree 2 links, or "grafts", to Hat Tree 1. The approving hat becomes the admin hat the Top Hat from Hat Tree 2.
If approved, Hat Tree 2 links, or "grafts", to Hat Tree 1. The approving hat becomes the admin hat of the Top Hat from Hat Tree 2.

Comment thread user_guide/user_guide.md

<img src=./assets/hatTreeLinking3.png width="600" height="400">


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The Top Hat from Tree 2, along with its associated branch, can be unlinked from Tree 1 at any point in the future, thereby returning back to the initial state of having two separate hats trees.

Comment thread user_guide/user_guide.md
You can mint a Top Hat with the `mintTopHat` function, which creates and mints a hat that is its own admin*, i.e. a `topHat`.


_*Note: New functionality is coming soon that will enable Top Hats and their associated trees to be linked and unlinked to other existing Hats trees, by changing the admin of a Top Hat._
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Delete "*Note: New functionality is coming soon that will enable Top Hats and their associated trees to be linked and unlinked to other existing Hats trees, by changing the admin of a Top Hat."

Comment thread user_guide/user_guide.md
*_These characteristics are new in v1_


You can mint a Top Hat with the `mintTopHat` function, which creates and mints a hat that is its own admin*, i.e. a `topHat`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Delete the * after "admin"

Comment thread user_guide/user_guide.md

<span style="color: red; font-weight: bold"> DRAFT </span>Last updated: 9 February

_Please add comments as you use this draft guide for anything that you feel could be clarified, improved, or added — thank you!_
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Delete "draft"

Comment thread user_guide/user_guide.md
## Step 3: Paste `id` in the `viewHat` function on the `Read Contract` page

# Eligibility and Toggle
Eligibility and toggle are dynamic and extensible modules that have the authority to rule on a hat wearer’s eligibility and standing (eligibility module) and switch the status of a hat (toggle module).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Add "on and off" just after "switch the status of a hat"

Comment thread user_guide/user_guide.md

The eligibility and toggle design space is huge. Future guides will dive deeper and explore more complex implementations of eligibility and toggle logic. This guide focuses on a simple implementation: setting eligibility and toggle as an address that determines eligibility and toggle for a given hat. This involves two contracts: `changeHatEligibility` and `changeHatToggle`.

By default, we recommend setting the eligibility and toggle addresses to the DAO's address (or the address wearing the Top Hat), so that the DAO retains the power to revoke hats and turn them off by vote, until more structure is put in place." might also be good to mention this when creating the hat in the first place.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Delete "might also be good to mention this when creating the hat in the first place."

Comment thread user_guide/user_guide.md
</td>
</tr>
</table>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Add "By default, we recommend setting the eligibility and toggle addresses to the DAO's address (or the address wearing the Top Hat), so that the DAO retains the power to revoke hats and turn them off by vote, until more structure is put in place."

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.

2 participants