public-assembly / flexible-docs

Flexible documentation.
https://docs.flexible.works/
MIT License
2 stars 0 forks source link

Manage roles draft #23

Closed Valcoholics closed 1 year ago

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: 128508045f37a9c62192effce8adcd086e648dd5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
flexible-docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 29, 2023 at 4:56AM (UTC)
Valcoholics commented 1 year ago

https://flexible-docs-git-12-feat-update-manage-3e569f-public-assembly.vercel.app/docs/theming/manage_roles

0xTranqui commented 1 year ago

Feedback (cc @Valcoholics):

  1. in the intro where we describe what the ThemeRegistry is, we can actually take out the "modular" approach. this actually isnt a modular approach, and the rules regarding access control are baked into the registry contract. we should be linking to this repo instead of the "remote-access-control" one
  2. i think its (only very slightly) confusing that we have the cool graphic of goerli.etherscan, but then are linking to mainnet etherscan. i dont think we need to change anything, but perhaps we could clarify some language about the theme registry being available at the same address on multiple chains? @salieflewis could you chime in here? also we're gonna need to provide support for the new testnet that is coming at some point, just flagging that for us to be aware of (cuz goerli might fully die)
  3. "On the contract's page, click on the "Connect to Web3" button located on the top right corner. This will prompt you to connect your wallet." I dont think most people know you can do this. i think a screenshot here would help
  4. The header "Write Contract" is confusing for more people I assume. I think something more like "prepare transaction" prob is a little easier to digest
  5. this bullet point "You'll need to provide the required input parameters." reads a little random. could we skip/remove this, or maybe if we want to keep it use it as a space to provide info on ethereum function inputs more generally?
  6. i think providing the roles first, then the tuple shape, and THEN providing the example input for them to swap in and out addresses/roles would make more sense. right now u read that first without knowing what the diff roles are or what even the tuple looks like which is confusing i think
  7. more screenshots for the "confirm transaction" bit may be helpful (particurarly in showing what it looks like on etherscan when someones wallet is properly connected, where to press send txn, etc)
  8. "Review the transaction details, and if everything looks correct, confirm the transaction." I actually think this is confusing and we should just remove it. "if everything looks correct" is not helpful to ppl who dont know what looks correct or not

random thing not super related to the content is that the styling of this site feels non cohesive with other PA brand touch points. idk if its final or not just calling it out. dont think its a big deal either way