docs: add badge to DeepWiki in the README #913

tbouffard · 2025-09-11T15:46:23Z

DeepWiki use the contents of the repository to create convenient documentation that can be requested. It provides complementary information to what the source code and the website provide.

Adding the badge to the README let people know about it and allow automatic refresh of the wiki every week.

Summary by CodeRabbit

Documentation
- Added a DeepWiki badge to the README next to the build status badge, improving discoverability and providing one-click access to documentation.
- No code, runtime, or build changes; purely a content update.
- Public APIs and user workflows remain unchanged.
- Development setup and CI are unaffected.
- No migrations or configuration changes required.

DeepWiki use the contents of the repository to create convenient documentation that can be requested. It provides complementary information to what the source code and the website provide. Adding the badge to the README let people know about it and allow automatic refresh of the wiki every week.

coderabbitai · 2025-09-11T15:46:30Z

Walkthrough

Added a DeepWiki badge line to README.md; content-only change with no code or behavior modifications.

Changes

Cohort / File(s)	Summary of Changes
Documentation update `README.md`	Inserted a DeepWiki badge line after the build status badge; no deletions or functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The current PR description explains DeepWiki and the reason for the badge but does not follow the repository's required template: it omits the PR Checklist and its checked items, lacks the structured Overview with change details and rationale, does not reference any issue or testing/screenshots, and provides no suggested merge commit message, so it is incomplete relative to the template.	Please update the PR description to use the provided template by completing or explaining each PR Checklist item, adding an Overview that details what changed and why, including any issue references (e.g., "closes #NNN") if applicable, and stating testing/screenshot status plus a short suggested merge commit message.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "docs: add badge to DeepWiki in the README" succinctly and accurately describes the primary change (adding a DeepWiki badge to the README) and follows the repository's "docs:" conventional prefix, so it is clear and appropriate for reviewers.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/readme_add_deepwiki_links

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.}

sonarqubecloud · 2025-09-11T15:47:06Z

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

7-7: Confirm intended scope: badge won’t propagate to copied docs sections.

Only the section after this line is auto-copied to packages/core/README.md and website docs. If you want the DeepWiki badge visible there too, add it manually in those files.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92d2445 and 8f7baa9.

📒 Files selected for processing (1)

README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: tbouffard
PR: maxGraph/maxGraph#849
File: packages/html/stories/DragSource.stories.js:98-101
Timestamp: 2025-06-13T07:48:10.300Z
Learning: User tbouffard prefers answers in English; avoid switching to other languages in future replies.

📚 Learning: 2025-04-22T16:34:40.309Z

Learnt from: tbouffard
PR: maxGraph/maxGraph#774
File: packages/ts-example-selected-features/package.json:11-13
Timestamp: 2025-04-22T16:34:40.309Z
Learning: In the maxGraph project, TypeScript is defined as a dependency in the root package.json (~5.8.2) and not in individual package.json files for example packages. The build scripts in example packages can use `tsc` commands because the TypeScript dependency is hoisted in the monorepo structure.

Applied to files:

README.md

📚 Learning: 2025-05-13T12:54:55.231Z

Learnt from: tbouffard
PR: maxGraph/maxGraph#826
File: packages/js-example-nodejs/src/index.cjs:64-69
Timestamp: 2025-05-13T12:54:55.231Z
Learning: For example code in the maxGraph repository, maintainers prefer to keep scripts simple without error handling to focus on demonstrating core functionality, especially in demonstration scripts like those in packages/js-example-nodejs.

Applied to files:

README.md

📚 Learning: 2025-04-22T16:34:40.309Z

Learnt from: tbouffard
PR: maxGraph/maxGraph#774
File: packages/ts-example-selected-features/package.json:11-13
Timestamp: 2025-04-22T16:34:40.309Z
Learning: In the maxGraph project, TypeScript is defined as a dependency in the root package.json and not in individual package.json files for example packages. The build scripts in example packages can use `tsc` because it's available through this hoisted dependency in the monorepo structure.

Applied to files:

README.md

📚 Learning: 2025-04-29T13:29:45.122Z

Learnt from: tbouffard
PR: maxGraph/maxGraph#791
File: packages/core/src/view/style/edge/Segment.ts:26-35
Timestamp: 2025-04-29T13:29:45.122Z
Learning: In the maxGraph project, JSDoc `{link}` references to symbols don't need to be imported in the current file to work correctly. TypeDoc can resolve symbols across the entire project namespace, not just within the current file, which is common in modern documentation systems and IDEs.

Applied to files:

README.md

🔇 Additional comments (1)

README.md (1)

5-5: LGTM — badge addition is clear and correctly placed.

Link target and alt text look fine; no build or content side-effects.

tbouffard added the documentation Improvements or additions to documentation label Sep 11, 2025

coderabbitai bot reviewed Sep 11, 2025

View reviewed changes

tbouffard merged commit 55074e6 into main Sep 11, 2025
2 checks passed

tbouffard deleted the docs/readme_add_deepwiki_links branch September 11, 2025 15:51

coderabbitai bot mentioned this pull request Oct 30, 2025

chore: add config files for some code assistant #930

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add badge to DeepWiki in the README #913

docs: add badge to DeepWiki in the README #913

Uh oh!

tbouffard commented Sep 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 11, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Sep 11, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

docs: add badge to DeepWiki in the README #913

docs: add badge to DeepWiki in the README #913

Uh oh!

Conversation

tbouffard commented Sep 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks (2 passed, 1 warning)

Uh oh!

sonarqubecloud bot commented Sep 11, 2025

Quality Gate passed

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented Sep 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 11, 2025 •

edited

Loading