[MOSIP-44051]: Updated README.md

[chetankh239]

Summary by CodeRabbit

• Documentation
  • Improved README formatting and readability, standardizing command block presentation and spacing.
  • Updated header badges and added a reference link to implementation details.
  • Added a "Contribution & Community" section with links for contributing, community support, and issue reporting.

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

[coderabbitai]

Walkthrough

Updated documentation: converted several bash code blocks to plain text formatting, standardized indentation and spacing in command examples, updated header badges and links, and added a new "Contribution & Community" section in two README files. No functional code changes.

Changes

Cohort / File(s)	Summary
Service README (formatting & community) biosdk-services/README.md	Converted bash blocks to text, standardized indentation/spacing for Maven and Docker examples, adjusted example run/health-check commands, and added a "Contribution & Community" subsection with contribution/support/issue links.
Project README (badges & link + community) README.md	Updated workflow and quality gate badge URLs/parameters, added a reference link to biosdk-services/README.md, and inserted a "Contribution & Community" section with links for contributions and issue reporting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Focus review on README content and badge URLs.
• Verify rendered Markdown for code blocks, indentation, and link targets.
• Confirm new "Contribution & Community" links point to intended locations.

Poem

🐰 A little hop through lines of text,
I fixed the spacing, nothing complex,
Badges gleam and links take flight,
Contribution doors now open bright,
Docs all tidy — what a sight! ✨

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 accurately describes the main change—updating README files with new sections, badge updates, and formatting improvements.
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

---

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

biosdk-services/README.md (1)

187-189: Missing code block marker on line 187.

The localhost swagger URL is missing the opening code block marker (```text) to maintain consistency with other similar examples in the document.

Apply this diff to add the code block marker:

 In case of localhost:

-```
+```text
 http://localhost:9099/biosdk-service/swagger-ui.html

</blockquote></details>

</blockquote></details>

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c1ffa6 and ca6024c.

📒 Files selected for processing (1)

• biosdk-services/README.md (7 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

biosdk-services/README.md

193-193: Link text should be descriptive

(MD059, descriptive-link-text)

🔇 Additional comments (2)

biosdk-services/README.md (2)

38-142: Formatting improvements are well-executed.

The conversion of command-output code blocks from bash to text, along with consistent indentation adjustments, improves readability and accurately represents the content type. The functional integrity of all commands remains intact.

---

191-197: New section enhances community engagement.

The "Contribution & Community" section provides clear pathways for users to contribute, seek support, and report issues—valuable additions to the README. Once the link text is improved, this section will be complete.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

10-16: Improve link text descriptiveness in Contribution section.

The link text "[click here]" on Line 12 is non-descriptive and should be replaced with text that clearly indicates the destination. Consider using text like "code contributions" that describes what users will find when they follow the link.

Similarly, "[Report here]" on Line 16 could be more descriptive (e.g., "create a GitHub issue").

This aligns with accessibility best practices and markdown standards. You can refactor as follows:

-• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions).
+• To learn how you can contribute code to this application, [see code contributions guide](https://docs.mosip.io/1.2.0/community/code-contributions).

-• For any GitHub issues: [Report here](https://github.com/mosip/biosdk-services/issues)
+• For any GitHub issues: [create a GitHub issue](https://github.com/mosip/biosdk-services/issues)

---

8-8: Improve reference link text for clarity.

The link text "[refer here]" is vague and non-descriptive. Consider using more specific text like "implementation details" or "service implementation" to improve clarity for readers.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca6024c and 3b9160c.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

12-12: Link text should be descriptive

(MD059, descriptive-link-text)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: biosdk-server / build-dockers

🔇 Additional comments (2)

README.md (2)

1-21: LGTM—Documentation improvements look good overall.

The addition of the "Contribution & Community" section enhances the README by making it easier for users to find contribution guidelines and community support resources. The badge URL updates appear to follow standard patterns and should improve workflow tracking visibility.

The feedback above focuses on improving link text descriptiveness (a documentation best practice) and verifying paths, but these are optional improvements rather than blockers.

---

2-3: Badge URLs are correctly configured and point to existing workflow files. The push-trigger.yml file exists in .github/workflows/, and the SonarCloud dashboard parameters are properly set with the correct project ID and branch reference.

[Varaniya201]

approved