-
Notifications
You must be signed in to change notification settings - Fork 20
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
feat: Public Creation removal of CType Creation #260
Conversation
This pull request is automatically being deployed by Amplify Hosting (learn more). |
Point is, I think when I worked on this snippet, there were requests to show the full flow, so people would not have to click right and left. Is this what we want here? That someone wanting to create a public credential now has to click and follow the guide on how to create a CType? It's fine by me, but back then people had different ideas. |
I believe that we are trying to reduce the burden on the user who wants to try public credentials. I think developing on the ideas and reasoning from last time: Yes the problem of making the user switch isn't great. But I think we should condense these ideas. I am open to ideas. |
IMO a snippet is a very small part of code that does exactly one thing. What you are talking about is a tutorial that explains a common workflow with public credentials from start to finish. I think both have their right to exist. |
This is an overall issue with our thought process. I think Albi is right, and we should maybe define each of these as a tutorial or an example. Therefore, we can be more aligned. I do think we would need a tutorial for most things. This can utilise more in-depth end-to-end explanations and practical examples for the user to see the whole flow. |
I thought about the cookbook more as a collection of snippets, but it's probably rather a collection of how-to guides. So each of the entries should be self contained and reproducible without additional setup. |
Should this be discussed as part of a larger documentation strategy meeting? |
I feel we are not yet all aligned on how the docs should look like. |
I think so too. But the main outcome of our meeting was to leave it for the tech writer. We only do the necessary docs upgrades and decisions. That being said, I think I will bring it up in the daily. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would not show the CType.fromProperties
twice. DRY principle :D
fixes https://github.com/KILTprotocol/ticket/issues/2703
Adding additional burden onto the docs user to build a CType was unnecessary. Removal of the CType takes away some of the friction.
Using existing CType will make this easier, though a reference to CType creation was added.
How to test:
yarn test (DUH)
Checklist: