fix: updated README with minimal setup and doc link

[Krishethaa]

This PR simplifies the README for new developers by including only the minimal setup instructions, as suggested in issue #1275. A link to the full documentation at https://docs.credebl.id has also been added for advanced configuration.

Summary by CodeRabbit

• Documentation
  • Simplified the README with a high-level project overview, minimal setup instructions, and links to official documentation.
  • Added sections for contribution guidelines, DCO signing, and license information.
  • Removed detailed technical setup and orchestration steps from the README.

[coderabbitai]

Walkthrough

The README.md file was completely rewritten, replacing a detailed technical setup guide with a concise project overview, minimal setup instructions, and new sections for contribution guidelines, DCO signing, license, and documentation links. All explicit environment and service orchestration commands were removed in favor of referencing external documentation.

Changes

File(s)	Change Summary
README.md	Replaced detailed setup instructions with a high-level overview, minimal startup steps, and added sections for contributions, DCO, license, and documentation links.

Poem

In README fields where details sprawled,
A rabbit hopped and gently called—
"Let’s keep it short, concise, and neat,
With docs to guide your eager feet.
Now setup’s simple, clear, and bright—
Hop in and code, from day to night!"
🐇✨

---

📜 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 d64441d and 5ccae0a.

📒 Files selected for processing (1)

• README.md (1 hunks)

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

• README.md

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (3)

README.md (3)

29-31: Clarify micro-service names

nest start <service-name> --watch assumes the reader knows the workspace names (agent, issuer, etc.). Consider adding an example (agent) or linking to the list under docs.

---

33-41: Link out to CONTRIBUTING & DCO docs

You mention “Contribution Guide” and “DCO signing” but don’t link them. Adding hyperlinks improves discoverability.

-We welcome PRs! Please read our Contribution Guide before submitting.
+We welcome PRs! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) before submitting.

and similarly for a “Developer Certificate of Origin” link.

---

48-60: “Steps After Editing README” feels out of scope for end-users

The section teaching contributors how to git add README.md is meta-documentation that clutters the quick-start flow. Suggest dropping it or moving to CONTRIBUTING.md.

-## 🛠️ Steps After Editing README
-...
-git add README.md
-git commit -m "fix: updated README with minimal setup and doc link"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd8eece and d64441d.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

README.md (1)

Learnt from: tipusinghaw
PR: credebl/platform#1297
File: apps/api-gateway/src/tracer.ts:24-28
Timestamp: 2025-06-24T11:15:29.468Z
Learning: In the credebl/platform repository, the team prefers to create utilities for validating required environment variables rather than implementing inline validation. This approach promotes reusability across different parts of the application.

[GHkrishna]

Thanks for the PR @Krishethaa

There are some things I would like to mention,

• The formatting seems a bit off, everything seems to be combined under a single formatting,
• also the start commands are incorrect, you might need to refer the docs thoroughly

[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

[Krishethaa]

"Hello @GHkrishna and reviewers,

I've incorporated all the valuable feedback into the README.md for this PR.

Specifically, I have:

Streamlined the 'Minimal Setup' section, focusing on core instructions.

Updated the API Gateway start command to npm run start:gateway:dev for better alignment with the project's scripts.

Included necessary prerequisites like Node.js version and Nest CLI installation.

Refined the formatting to enhance readability.

Please let me know if there are any further adjustments needed. Ready for your re-review!"

[GHkrishna]

Do you mind having a look at the docs once, we've mentioned the steps to start there.

[ankita-p17]

Hi @Krishethaa Could you please take a look at docs mentioned in earlier comment. Also, there is some development on README which resulted in conflict, please resolve it so that we can merge/close this PR.