docs(readme): add prominent DeepWiki callout at top#406
Open
mxhrbrgr wants to merge 1 commit into
Open
Conversation
Add a highlighted callout box promoting the DeepWiki documentation and its interactive chat feature for getting code examples and explanations. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
mxhrbrgr
requested review from
biering,
functionistic,
langenhagen and
mahsumdemirwb
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a prominent entry-point in the root README to direct new users to the project’s DeepWiki documentation and chat-based help, complementing the existing “Ask DeepWiki” badge.
Changes:
- Insert a new callout near the top of README promoting DeepWiki docs and interactive chat for examples/explanations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](https://github.com/wandelbotsgmbh/wandelbots-nova/actions/workflows/nova-release.yaml) | ||
| [](https://deepwiki.com/wandelbotsgmbh/wandelbots-nova) | ||
|
|
||
| > **📚 New to the SDK?** Explore the [DeepWiki documentation](https://deepwiki.com/wandelbotsgmbh/wandelbots-nova) for architecture guides and tutorials. You can also **chat with it** to get code examples, detailed explanations, and answers to your questions. |
There was a problem hiding this comment.
The PR description/title says this should be a “prominent callout box”, but this is currently formatted as a plain blockquote. Consider switching to GitHub’s alert/admonition syntax (e.g., a TIP/NOTE style) so it renders as an actual callout box and is consistent with the existing [!WARNING] block used later in the README.
| [](https://github.com/wandelbotsgmbh/wandelbots-nova/actions/workflows/nova-release.yaml) | ||
| [](https://deepwiki.com/wandelbotsgmbh/wandelbots-nova) | ||
|
|
||
| > **📚 New to the SDK?** Explore the [DeepWiki documentation](https://deepwiki.com/wandelbotsgmbh/wandelbots-nova) for architecture guides and tutorials. You can also **chat with it** to get code examples, detailed explanations, and answers to your questions. |
There was a problem hiding this comment.
Minor clarity: “chat with it” is a bit ambiguous in isolation; consider naming the subject explicitly (e.g., “chat with DeepWiki”) so readers don’t have to infer what “it” refers to.
Suggested change
| > **📚 New to the SDK?** Explore the [DeepWiki documentation](https://deepwiki.com/wandelbotsgmbh/wandelbots-nova) for architecture guides and tutorials. You can also **chat with it** to get code examples, detailed explanations, and answers to your questions. | |
| > **📚 New to the SDK?** Explore the [DeepWiki documentation](https://deepwiki.com/wandelbotsgmbh/wandelbots-nova) for architecture guides and tutorials. You can also **chat with DeepWiki** to get code examples, detailed explanations, and answers to your questions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a highlighted callout box promoting the DeepWiki documentation and its interactive chat feature for getting code examples and explanations.
🤖 Generated with Claude Code