Add CREDEBL UI User Guide documentation #2
Conversation
Added a comprehensive user guide covering the CREDEBL UI modules including Users, Ledger, Organizations, Connections, Issuance, and Verification. Includes navigation steps, best practices, troubleshooting tips, and relevant resource links. Signed-off-by: SpandanaKona <[email protected]>
|
Hi , All checks have passed, there are no conflicts, and the changes are ready to merge. This PR adds a comprehensive CREDEBL UI User Guide covering Users, Ledger, Organizations, Connections, Issuance, and Verification. Could you please review and merge it at your earliest convenience? Thank you! |
|
Hi team, All checks have passed and the PR has no conflicts. Could you please review and merge it when you have time? |
|
Hey @konaspandana017 Thanks for the PR We are just checking some configurations with the tool we are using for maintaining the docs. We can merge the PR as soon as we have that sorted. |
There was a problem hiding this comment.
I was thinking if we could maybe add this as a page inside the guides section. Just rename the section as UI User guide. Or maybe add a subsection under it. Even though I'm not really sure what other guides we might have apart from the UI User guide for now
CREDEBL-UI-User-Guide.md
Outdated
| ## Accessing the Platform | ||
| 1. Open your browser. | ||
| 2. Navigate to your environment: | ||
| - Local development: http://localhost:5000 |
There was a problem hiding this comment.
| - Local development: http://localhost:5000 | |
| - Local development: http://localhost:5000/api |
There was a problem hiding this comment.
Its not currently auto redirected to /api for now. Have a look at this issue: credebl/platform#1527
CREDEBL-UI-User-Guide.md
Outdated
| 2. Navigate to your environment: | ||
| - Local development: http://localhost:5000 | ||
| - Hosted environment: as provided by your administrator | ||
| 3. Log in using your credentials or developer account for local setups. |
There was a problem hiding this comment.
or developer account
Do you mean using the client credentials here?
|
|
||
| ## Accessing the Platform | ||
| 1. Open your browser. | ||
| 2. Navigate to your environment: |
There was a problem hiding this comment.
I'm a bit unsure of why we are navigating to the backend if its the UI guide??
For UI, we can have localhost:3000
CREDEBL-UI-User-Guide.md
Outdated
|
|
||
| ### Organizations | ||
| - **Add Organization**: Provide name, type, and assign credentials. | ||
| - **Manage Credentials**: Assign, revoke, or view credentials for organizations. |
There was a problem hiding this comment.
Assign, revoke, or view credentials for organizations.
Not sure about this.
Do you mean inviting user and giving them different roles? (ORG invitation part)
CREDEBL-UI-User-Guide.md
Outdated
| ### Issuance & Verification | ||
| - **Issue Credential**: | ||
| 1. Select credential type. | ||
| 2. Choose recipient (user or organization). |
There was a problem hiding this comment.
organization
I'm not sure if we have this ability yet.
Can you please elaborate what exactly you mean here
CREDEBL-UI-User-Guide.md
Outdated
| 2. Choose recipient (user or organization). | ||
| 3. Fill required fields. | ||
| 4. Click Issue Credential. | ||
| - **Verify Credential**: |
There was a problem hiding this comment.
Actually here a more suited word would be sending a verification request similar to that of issuing credential
CREDEBL-UI-User-Guide.md
Outdated
| - **Verify Credential**: | ||
| 1. Enter credential ID. | ||
| 2. System checks ledger. | ||
| 3. Displays verification result. |
There was a problem hiding this comment.
It makes sense her ig to have some hints of using a wallet to store credentials. Something like https://play.google.com/store/apps/details?id=id.credebl.adeya and https://apps.apple.com/in/app/sovio-wallet-adeya-wallet/id6463845498
CREDEBL-UI-User-Guide.md
Outdated
| - Docker Documentation: https://docs.docker.com/ | ||
| - NATS Documentation: https://docs.nats.io/ |
There was a problem hiding this comment.
Why this links, maybe having link to the local-deployment section would be more appropriate
Updated the CREDEBL UI User Guide to include versioning, improved instructions, and additional details for various sections. Signed-off-by: SpandanaKona <[email protected]>
3 participants
Added a comprehensive user guide covering the CREDEBL UI modules including Users, Ledger, Organizations, Connections, Issuance, and Verification. Includes navigation steps, best practices, troubleshooting tips, and relevant resource links.