fix: updated README with minimal setup and doc link #1365
Conversation
WalkthroughThe 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
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
README.md (3)
29-31: Clarify micro-service names
nest start <service-name> --watchassumes 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 docsYou 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-usersThe section teaching contributors how to
git add README.mdis meta-documentation that clutters the quick-start flow. Suggest dropping it or moving toCONTRIBUTING.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
📒 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.
|
Thanks for the PR @Krishethaa There are some things I would like to mention,
|
|
|
"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!" |
|
Do you mind having a look at the docs once, we've mentioned the steps to start there. |
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