Skip to content

docs: add Deepwiki link to README and contributing guide#4201

Merged
arkid15r merged 5 commits intoOWASP:mainfrom
Jpeg-create:move-env-variable-docs
Mar 7, 2026
Merged

docs: add Deepwiki link to README and contributing guide#4201
arkid15r merged 5 commits intoOWASP:mainfrom
Jpeg-create:move-env-variable-docs

Conversation

@Jpeg-create
Copy link
Contributor

Proposed change

Resolves #4195

Added Nest's Deepwiki link to CONTRIBUTING.md, backend/README.md, and frontend/README.md.

Checklist

  • Required: I followed the contributing workflow
  • Required: I verified that my code works as intended and resolves the issue as described
  • I used AI for code, documentation, tests, or communication related to this PR

@github-actions github-actions bot added docs Improvements or additions to documentation backend frontend labels Mar 7, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 7, 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: 48caa6f8-ad23-4f39-bbf7-2e4234797daa

📥 Commits

Reviewing files that changed from the base of the PR and between 65defd2 and face447.

📒 Files selected for processing (6)
  • CONTRIBUTING.md
  • README.md
  • backend/README.md
  • docs/schema/index.md
  • frontend/README.md
  • infrastructure/README.md
✅ Files skipped from review due to trivial changes (1)
  • infrastructure/README.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • backend/README.md
  • CONTRIBUTING.md

Summary by CodeRabbit

  • Documentation
    • Added External Documentation sections with reference links to OWASP resources and comprehensive guides across contributing guidelines, project README files, and technical documentation, enhancing available learning materials for users.

Walkthrough

Added External Documentation / Documentation subsections linking to Nest DeepWiki and ReadTheDocs across repository README and CONTRIBUTING files and several component READMEs. No code, API, or behavior changes.

Changes

Cohort / File(s) Summary
Top-level docs
CONTRIBUTING.md, README.md
Inserted "External Documentation" / "Documentation" subsections with bullet links to Nest DeepWiki and ReadTheDocs; content-only additions.
Component READMEs
backend/README.md, frontend/README.md, infrastructure/README.md
Added an "External Documentation" entry linking to OWASP/Nest DeepWiki under Dependencies/Documentation sections; documentation-only changes.
Site docs / schema
docs/schema/index.md
Added a DeepWiki link under OWASP Schema; content-only addition.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • kasya
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding Deepwiki links to documentation files (README and contributing guide).
Description check ✅ Passed The description is related to the changeset, specifying the issue resolved, files modified, and completion of required checklist items.
Linked Issues check ✅ Passed The PR successfully implements the objective from issue #4195 by adding Nest's Deepwiki link to multiple documentation files as requested.
Out of Scope Changes check ✅ Passed All changes are within scope: additions are limited to documentation/content in README and CONTRIBUTING files, directly addressing the linked issue #4195.
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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 39-41: Remove the trailing whitespace after the link in the "##
Documentation" section by editing the Markdown line with the "[Nest
Deepwiki](https://deepwiki.com/OWASP/Nest)" link (under the "Documentation"
header) so it has no trailing space at the end of the line; this will satisfy
markdownlint MD009.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 35c7dd21-e1c8-4fbe-9ccc-03f7a0bf77f9

📥 Commits

Reviewing files that changed from the base of the PR and between 833d763 and eb7ec4f.

📒 Files selected for processing (4)
  • CONTRIBUTING.md
  • README.md
  • backend/README.md
  • frontend/README.md

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 4 files

Confidence score: 4/5

  • This PR looks safe to merge overall, with low product risk; the noted issue is a formatting hygiene problem rather than a functional regression.
  • The most significant concern is in frontend/README.md: trailing whitespace and a missing final newline may violate pre-commit formatting rules and cause make check-test/CI to fail until corrected.
  • Given the issue’s moderate-low severity (4/10) and documentation-only scope, risk is mainly merge friction in automated checks, not runtime behavior.
  • Pay close attention to frontend/README.md - fix whitespace/newline formatting to avoid CI/check failures.
Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="frontend/README.md">

<violation number="1" location="frontend/README.md:83">
P2: Added README line has trailing whitespace (and file lacks final newline), which violates enforced pre-commit formatting checks and can fail `make check-test`/CI.</violation>
</file>

Since this is your first cubic review, here's how it works:

  • cubic automatically reviews your code and comments on bugs and improvements
  • Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
  • Add one-off context when rerunning by tagging @cubic-dev-ai with guidance or docs links (including llms.txt)
  • Ask questions if you need clarification on any suggestion

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 7, 2026
coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 7, 2026
@Jpeg-create Jpeg-create marked this pull request as ready for review March 7, 2026 22:59
@arkid15r arkid15r enabled auto-merge March 7, 2026 23:24
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 7, 2026

@codecov
Copy link

codecov bot commented Mar 7, 2026

Codecov Report

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

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4201   +/-   ##
=======================================
  Coverage   99.71%   99.71%           
=======================================
  Files         519      519           
  Lines       16068    16068           
  Branches     2192     2192           
=======================================
  Hits        16022    16022           
  Misses         38       38           
  Partials        8        8           
Flag Coverage Δ
backend 99.70% <ø> (ø)
frontend 99.72% <ø> (ø)

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 c35d7d6...face447. 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.

@arkid15r arkid15r added this pull request to the merge queue Mar 7, 2026
Merged via the queue into OWASP:main with commit 2701f40 Mar 7, 2026
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend docs Improvements or additions to documentation frontend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Nest's Deepwiki link to Readme/contributing guide

2 participants