docs: add comprehensive CREDEBL UI user guide

[konaspandana017]

This PR adds a complete User Guide for the CREDEBL UI workflow.
It covers all main modules including Users, Ledger, Organizations, Connections, Issuance, and Verification.
The guide provides step-by-step instructions for accessing, navigating, and using the platform, along with best practices, troubleshooting tips, and links to additional resources.

Changes include:

• New file: docs/CREDEBL-UI-User-Guide.md
• Detailed instructions for all major UI modules
• Troubleshooting tips and best practices for developers and users

This guide aims to help new contributors and users interact with the platform confidently.

Summary by CodeRabbit

• Documentation
  • Added a comprehensive CREDEBL UI User Guide covering platform overview, access and navigation instructions, dashboard components, module-specific workflows (Users, Ledger, Organizations, Connections, Issuance & Verification), best practices, troubleshooting tips, and additional resources for end users.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

A new user guide Markdown file, docs/CREDEBL-UI-User-Guide.md, was added describing platform overview, access, dashboard components, workflows for Users, Ledger, Organizations, Connections, Issuance & Verification, navigation tips, best practices, troubleshooting, and additional resources (documentation only; no code changes).

Changes

Cohort / File(s)	Summary
Documentation docs/CREDEBL-UI-User-Guide.md	Added a comprehensive UI user guide covering platform overview, access instructions, dashboard components, module-specific workflows (Users, Ledger, Organizations, Connections, Issuance & Verification), navigation tips, best practices, troubleshooting, and resource links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Pure documentation addition with no code or configuration changes.
• Single file; review should focus on completeness, clarity, accuracy of procedural steps, and validity of links.

Poem

🐰 A guide appears, soft-footed and bright,

Steps lined like carrots in gentle light,
Modules mapped, each path clear and true,
Hop through the pages — they'll guide you through,
A tiny rabbit cheers: "Read on — away you flew!"

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding a comprehensive user guide for the CREDEBL UI, which matches the PR's primary objective of introducing docs/CREDEBL-UI-User-Guide.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54c66ec and 0dc3430.

📒 Files selected for processing (1)

• docs/CREDEBL-UI-User-Guide.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/CREDEBL-UI-User-Guide.md

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (3)

docs/CREDEBL-UI-User-Guide.md (3)

7-12: Add a prerequisites or system requirements section.

The "Accessing the Platform" section lacks information about prerequisites such as:

• Supported browsers and versions
• System requirements (RAM, disk space, etc.)
• Required permissions or roles
• Network requirements (if applicable)

Consider adding a dedicated "Prerequisites" or "System Requirements" section before "Accessing the Platform" to set user expectations and reduce troubleshooting queries.

---

61-64: Expand the troubleshooting section with more comprehensive guidance.

The troubleshooting section covers only three scenarios and offers minimal remediation steps. Consider adding:

• Common authentication or permission-related issues
• API connectivity or timeout errors
• Data sync or caching issues
• Steps for collecting logs or error details for support
• Links to known issues or GitHub discussions

This will reduce support overhead and improve user self-sufficiency.

---

3-5: Consider adding a brief SSI primer for unfamiliar users.

While the guide assumes familiarity with Self-Sovereign Identity concepts, adding a one-sentence explanation of SSI and Verifiable Credentials in the introduction could improve accessibility for new users unfamiliar with these terms. This might encourage broader adoption and reduce onboarding friction.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8c20270 and 08c43ae.

📒 Files selected for processing (1)

• docs/CREDEBL-UI-User-Guide.md (1 hunks)

🔇 Additional comments (2)

docs/CREDEBL-UI-User-Guide.md (2)

68-68: Clarify the relative link path for the Backend Setup & Environment Guide.

Line 68 links to README.md as a relative path. This may resolve incorrectly depending on the documentation structure. Consider using a full relative path (e.g., ../README.md) or an absolute repository link to ensure the link works reliably in all contexts (GitHub, documentation sites, etc.).

---

1-73: Comprehensive documentation structure and user-focused content.

The guide provides clear step-by-step instructions, logical module organization, and practical navigation tips. The content is well-structured and approachable for both new and experienced users. The inclusion of best practices and troubleshooting sections adds practical value. Once the link clarifications and minor enhancements above are addressed, this guide will serve as a solid foundation for user onboarding.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[konaspandana017]

Hi maintainers ,

I’ve addressed all the suggestions and all checks have passed.
This PR only adds documentation and is now ready for review.

Could you please take a moment to review and approve it when you get time?
Thank you for your support!

[ajile-in]

Hello @konaspandana017,
Thanks for your contribution. The platform documentation is maintained in the docs repository. Can you please raise your PR there?