Skip to content

docs: integrate DeepWiki (.devin/wiki.json + README badge) - #53

Merged
markovejnovic merged 4 commits into
mainfrom
docs/deepwiki
Jul 7, 2026
Merged

docs: integrate DeepWiki (.devin/wiki.json + README badge)#53
markovejnovic merged 4 commits into
mainfrom
docs/deepwiki

Conversation

@markovejnovic

Copy link
Copy Markdown
Contributor

Summary

  • Add .devin/wiki.json with repo_notes steering DeepWiki wiki generation (privilege boundary, subsystem map, gitignored generated code, test taxonomy, canonical docs pointers)
  • Add the official DeepWiki badge to the README badge row, which enables DeepWiki's free weekly auto-refresh
  • README ## Docs section now points readers at the DeepWiki with an explicit not-the-source-of-truth disclaimer

Repo is already indexed at https://deepwiki.com/harmont-dev/hyper; these changes take effect on the next refresh after merge. DeepWiki reads .devin/wiki.json from the default branch only.

Verification

  • jq schema validation of .devin/wiki.json (repo_notes only, ≤100 notes, ≤10k chars/note): passes
  • Badge and wiki URLs return HTTP 200
  • Every factual claim in the repo_notes verified against the tree (paths, mix aliases, gitignore coverage, crate/package names)
  • Gates green: format, compile --warnings-as-errors, credo --strict, dialyzer (0 errors), 314 tests

@codecov

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

Test Results

  3 files  ±0  155 suites  ±0   1m 33s ⏱️ -56s
457 tests ±0  457 ✅ ±0    0 💤 ±0  0 ❌ ±0 
778 runs  ±0  457 ✅ ±0  321 💤 ±0  0 ❌ ±0 

Results for commit c4b6d57. ± Comparison against base commit e92d7f1.

@markovejnovic
markovejnovic merged commit 638cf4b into main Jul 7, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant