Skip to content

docs: add README header badges (DeepWiki + ReadTheDocs)#4232

Merged
arkid15r merged 4 commits intoOWASP:mainfrom
hassaansaleem28:add/deepwiki-and-docs-badge
Mar 10, 2026
Merged

docs: add README header badges (DeepWiki + ReadTheDocs)#4232
arkid15r merged 4 commits intoOWASP:mainfrom
hassaansaleem28:add/deepwiki-and-docs-badge

Conversation

@hassaansaleem28
Copy link
Contributor

Proposed change

Resolves #4212

Summary

This PR updates the root README.md badges section by adding badges for deepwiki to auto-refresh and to read the docs.

Changes

  • Added a DeepWiki badge
  • Added a Read the Docs badge

Checklist

  • Required: I followed the contributing workflow
  • Required: I verified that my code works as intended and resolves the issue as described
  • Required: I ran make check-test locally: all warnings addressed, tests passed
  • I used AI for code, documentation, tests, or communication related to this PR

Signed-off-by: Muhammad Hassaan Saleem <iamhassaans@gmail.com>
@github-actions github-actions bot added the docs Improvements or additions to documentation label Mar 10, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b9ef8125-8046-4223-8895-0f9f28288eff

📥 Commits

Reviewing files that changed from the base of the PR and between 0dd2ce6 and a9d8930.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Summary by CodeRabbit

  • Documentation
    • Added DeepWiki and ReadTheDocs badges to README
    • Introduced Issues and Pull Requests badges for improved project visibility and accessibility

Walkthrough

Adds DeepWiki and ReadTheDocs badges plus explicit Issues and Pull Requests badges to README.md. Pure documentation change; no code or exported/public API modifications.

Changes

Cohort / File(s) Summary
README badge updates
README.md
Added DeepWiki and ReadTheDocs badges and introduced Issues and Pull Requests badges to the existing badge row; net +4/−2 lines, no runtime changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • kasya
🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR adds a ReadTheDocs badge which is not mentioned in the linked issue #4212 that only requests the DeepWiki badge addition. Verify that the ReadTheDocs badge addition is authorized; if out of scope, remove it or open a separate issue to track this enhancement.
Linked Issues check ❓ Inconclusive The PR addresses issue #4212 by adding the DeepWiki badge to README; however, it also adds a ReadTheDocs badge which was not mentioned in the linked issue. Clarify whether the ReadTheDocs badge addition is part of the original issue #4212 scope or if it is a secondary enhancement that should be documented.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding DeepWiki and ReadTheDocs badges to the README header section.
Description check ✅ Passed The description is related to the changeset, explaining the addition of DeepWiki and Read the Docs badges to the README.md file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 10, 2026
Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@arkid15r arkid15r enabled auto-merge March 10, 2026 21:13
@sonarqubecloud
Copy link

@arkid15r arkid15r disabled auto-merge March 10, 2026 22:09
@arkid15r arkid15r merged commit b38aa28 into OWASP:main Mar 10, 2026
33 checks passed
@codecov
Copy link

codecov bot commented Mar 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.42%. Comparing base (16f5812) to head (a9d8930).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4232   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files         519      519           
  Lines       16164    16164           
  Branches     2212     2170   -42     
=======================================
  Hits        16071    16071           
  Misses         69       69           
  Partials       24       24           
Flag Coverage Δ
backend 99.70% <ø> (ø)
frontend 98.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 16f5812...a9d8930. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add deepwiki badge in README for auto-refresh

2 participants