From 54c66ec69d4a6fbedbc217c8b3db394e58cb5f54 Mon Sep 17 00:00:00 2001 From: konaspandana017 <2400032836@kluniversity.in> Date: Fri, 14 Nov 2025 15:25:23 +0530 Subject: [PATCH 1/2] docs: add comprehensive CREDEBL UI user guide Signed-off-by: konaspandana017 <2400032836@kluniversity.in> --- docs/CREDEBL-UI-User-Guide.md | 73 +++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 docs/CREDEBL-UI-User-Guide.md diff --git a/docs/CREDEBL-UI-User-Guide.md b/docs/CREDEBL-UI-User-Guide.md new file mode 100644 index 000000000..70ec3c3ef --- /dev/null +++ b/docs/CREDEBL-UI-User-Guide.md @@ -0,0 +1,73 @@ +# CREDEBL UI User Guide + +## Introduction +CREDEBL is an open-source Self-Sovereign Identity (SSI) and Verifiable Credentials platform. +This guide helps users navigate the CREDEBL User Interface (UI) efficiently. + +## Accessing the Platform +1. Open your browser. +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. + +## Dashboard Overview +- **Users**: Manage users and their credentials. +- **Ledger**: View issued credentials and verification history. +- **Organizations**: Manage organizational accounts and credentials. +- **Connections**: Track SSI connections and their status. +- **Issuance & Verification**: Issue credentials or verify existing ones. + +## Navigation +- Use the **sidebar menu** to switch between modules. +- Hover over icons to see tooltips explaining their functions. +- Use search bars and filters to quickly locate records. + +## Modules + +### Users +- **Add User**: Fill required fields and click *Create*. +- **Search Users**: Filter by ID, name, or email. +- **View Details**: Click on a user to view full credentials and history. + +### Ledger +- Lists all issued credentials with columns like credential ID, type, issuer, and status. +- Filter results by type, status, or date range. + +### Organizations +- **Add Organization**: Provide name, type, and assign credentials. +- **Manage Credentials**: Assign, revoke, or view credentials for organizations. + +### Connections +- Shows active SSI connections including status, last activity, and associated users. +- Use filters to locate specific connections. + +### Issuance & Verification +- **Issue Credential**: + 1. Select credential type. + 2. Choose recipient (user or organization). + 3. Fill required fields. + 4. Click *Issue Credential*. +- **Verify Credential**: + 1. Enter credential ID. + 2. System checks ledger. + 3. Displays verification result. + +## Best Practices +- Verify credentials before issuing. +- Ensure all environment variables are correctly configured. +- Restart services if UI is not reflecting updates. + +## Troubleshooting +- **UI not accessible**: Confirm API Gateway and microservices are running. +- **Credential issuance errors**: Check Prisma database schema and restart services. +- **UI outdated**: Clear browser cache or restart frontend. + +## Additional Resources +- [CREDEBL GitHub Repository](https://github.com/credebl/platform) +- [Backend Setup & Environment Guide](README.md) +- [Docker & NATS Documentation](https://docs.docker.com/) + +--- + +*This guide is maintained by contributors and will be updated as CREDEBL evolves.* From 0dc34305c67be039e815fae6a2919d75f2b159a5 Mon Sep 17 00:00:00 2001 From: SpandanaKona <2400032836@kluniversity.in> Date: Sat, 22 Nov 2025 22:58:07 +0530 Subject: [PATCH 2/2] Update documentation for Docker and NATS links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updated the Additional Resources section to correctly reference the official NATS documentation. Previously, the link labeled “Docker & NATS Documentation” pointed only to the Docker docs homepage, which did not provide relevant information for NATS-specific setup or usage. This update replaces the incorrect link and adds a direct link to: - NATS official documentation: https://docs.nats.io This improves the accuracy and usefulness of the User Guide by ensuring developers and contributors have quick access to the correct NATS resources. Signed-off-by: SpandanaKona <2400032836@kluniversity.in> --- docs/CREDEBL-UI-User-Guide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/CREDEBL-UI-User-Guide.md b/docs/CREDEBL-UI-User-Guide.md index 70ec3c3ef..de77c3d40 100644 --- a/docs/CREDEBL-UI-User-Guide.md +++ b/docs/CREDEBL-UI-User-Guide.md @@ -66,7 +66,9 @@ This guide helps users navigate the CREDEBL User Interface (UI) efficiently. ## Additional Resources - [CREDEBL GitHub Repository](https://github.com/credebl/platform) - [Backend Setup & Environment Guide](README.md) -- [Docker & NATS Documentation](https://docs.docker.com/) +- [Docker Documentation](https://docs.docker.com/) +- [NATS Documentation](https://docs.nats.io/) + ---