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

Account descriptions #208

Open
helins opened this issue Nov 4, 2021 · 7 comments
Open

Account descriptions #208

helins opened this issue Nov 4, 2021 · 7 comments

Comments

@helins
Copy link
Member

helins commented Nov 4, 2021

Account descriptions can be registered under :description by calling *registry*/register. I did provide some descriptions for officials libs and actors and they are typically needed to really understand them. It can be retrieved by using *registry*/lookup.

I think with time, the current reference should be refactored but that's another discussion :)
Currently, a place we could focus on is providing this description in the account view/renderer. What do you think?

@pedrorgirardi
Copy link
Collaborator

pedrorgirardi commented Nov 6, 2021

I think it's a good idea! I'm happy to do that.

Screen Shot 2021-11-06 at 9 43 13 AM

@helins
Copy link
Member Author

helins commented Nov 8, 2021

Cool, let me know if you need some help at some point :)

@pedrorgirardi
Copy link
Collaborator

Suggestions @mikera @helins ?

Screenshot 2021-11-15 at 09-44-17 Convex

Screenshot 2021-11-15 at 09-44-10 Convex

@helins
Copy link
Member Author

helins commented Nov 15, 2021

Great, thanks :)
If we could add description to vars on this page, we wouldn't need the reference (https://convex.world/cvm/reference) and you could see doc for all accounts, not just a selection of official ones. We could brainstorm that if you want

@mikera
Copy link
Member

mikera commented Nov 16, 2021

Happy to brainstorm! My crazy idea is that this could be something like a DAO that maintains latest high-level documentation for approved libraries on-chain

@helins
Copy link
Member Author

helins commented Nov 18, 2021

That rather orthogonal I'd say, how to maintain a registry of useful accounts. What I was referring to was a generic way of getting information about an account.

Ideally, the account page would centralize everything you need to know. So when you click on a symbol, instead of seing merely the value (as seen on the screenshot), there would de:

  • Doc about symbol (by following its :doc metadata)
  • Compact value (i.e. print whole value if small, only beginning if large with a button to expand)
  • Fields for calling it if it is a callable function (you wouldn't need the current "callable functions" section)

What do you think?

Screenshot from 2021-11-18 08-28-58

@mikera
Copy link
Member

mikera commented Jul 5, 2023

This is a very good idea but we should hold until we can figure out best way to do:

  • Heirarchical CNS
  • DID-based identities

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

No branches or pull requests

3 participants