Add DeepWiki badge (#824)

* Add DeepWiki badge

Updated README to include DeepWiki badge for auto-updating deepwiki docs

* docs(contributing): give DeepWiki its own section with badge

The link was buried at the end of "Getting Your Pull Request Merged", a
section about PR etiquette rather than reading code. Move it under its own
heading at the top of Helpful Tips, where someone about to explore the
codebase will actually look, and add the badge to match the README.

---------

Co-authored-by: octoshrimpy <git@octo.sh>
This commit is contained in:
octoshrimpy
2026-08-01 15:04:26 -04:00
committed by GitHub
parent ca9640afa2
commit 691ac19a9e
2 changed files with 7 additions and 5 deletions
+5 -2
View File
@@ -64,12 +64,15 @@ To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshr
## Helpful Tips
### Understand the Codebase
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/octoshrimpy/quik)
Feel free to use [deepwiki LLM](https://deepwiki.com/octoshrimpy/quik) to understand the code structure before contributing and explore the implementation interactively.
### Getting Your Pull Request Merged
When submitting a pull request, please be as detailed as possible in your reasoning for the change, what you changed and how you tested it. \
In addition, please try to keep pull requests atomic and singularly focused. Submitting large pull requests that have multiple changes or touch multiple code paths are much more difficult to review and may be asked to be split apart.
Feel free to use [deepwiki LLM](https://deepwiki.com/octoshrimpy/quik) to understand the code structure before contributing and explore the implementation interactively.
### Open Draft Pull Requests
If you are stuck or in the middle of a larger code change, open up a draft pull request. That way you can receive help and suggestions while you are developing. \
If you are stuck on something specific open up that draft PR, or hop on over to [matrix](https://matrix.to/#/#quik-sms:matrix.org) for suggestions.
+2 -3
View File
@@ -3,9 +3,8 @@
# QUIK
[![Manual Release](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml/badge.svg)](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml)
<a href="https://hosted.weblate.org/engage/quik/">
<img src="https://hosted.weblate.org/widget/quik/svg-badge.svg" alt="Translation status" />
</a>
<a href="https://hosted.weblate.org/engage/quik/"><img src="https://hosted.weblate.org/widget/quik/svg-badge.svg" alt="Translation status" /></a>
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/octoshrimpy/quik)
QUIK is an open source replacement to the [stock messaging app](https://github.com/android/platform_packages_apps_mms) on Android. It is a continuation of [QKSMS](https://github.com/moezbhatti/qksms).