-
Notifications
You must be signed in to change notification settings - Fork 2
DeepWiki Mirror
| Source | Role | Trust boundary |
|---|---|---|
| Private Devin Wiki | Documentation-generation and discovery aid | Private, provider-authenticated; not a GitHub Actions writer |
| Public DeepWiki | Optional public discovery surface | Indexed, source-linked snapshot verified 2026-08-20; validate its source ref and material claims before adoption. |
In-repository wiki/ directory |
GitHub Wiki publication source | Reviewed repository content |
| GitHub Wiki | Published Markdown projection | Updated only by the managed publisher |
Devin can generate structured documentation, diagrams, and source links. GitHub Wiki is a separate *.wiki.git repository. The authoritative mirror mechanism is the reviewed wiki/ directory and .github/workflows/publish-wiki.yml; it does not retrieve undocumented private Devin Wiki pages. Public DeepWiki may lag the default branch or refresh on a provider-controlled cadence, so an indexed page is useful for discovery but never replaces current source validation.
- Documentation intended for publication is added to
wiki/through the normal repository review process. - A change merged to the repository default branch that touches
wiki/**runs the managedPublish wikiworkflow. - The workflow publishes
wiki/tohttps://github.com/timerloggedout-spec/termux-monorepo/wiki. - The control-plane reconciler detects repositories reachable by the repository’s established job-scoped operator-token lane and can propose the same publisher as a reviewable PR. It never changes a default branch or merges a PR.
The publisher may be manually dispatched with dry_run=true to validate its configuration without modifying GitHub Wiki.
GitHub creates the *.wiki.git backend after the first wiki page exists. If this repository’s Wiki has not yet been initialized, create a page such as Home in the Wiki UI, merge the source change, then run Actions → Publish wiki. If the first run fails because the Wiki is empty, use strategy: init for one reviewed bootstrap run before returning to strategy: clone.
Devin’s documented .devin/wiki.json configuration can steer which pages its generator produces. It is appropriate to use that configuration to improve documentation coverage, but it is not an export or synchronization interface.
A human should review and bring generated content into this repository using one of these evidence-preserving paths:
- Export or copy the desired Devin Wiki material through an authenticated Devin session, then add normalized Markdown under
wiki/in a pull request. - Ask a Devin session to prepare Markdown files suitable for GitHub Wiki, then review the result and commit the approved pages under
wiki/. - Use a public exporter only while the public DeepWiki repository is actually indexed; preserve the source URL, indexed source reference, and verification date in the pull request.
Do not store Devin API tokens, browser cookies, or exported session state in this repository. Treat agent-generated claims as discovery aids and corroborate material statements with repository source, commits, or issue/PR evidence.
-
Home.mdis the landing page. - Filenames become page titles (
My-Page.mdbecomes “My Page”). - Avoid
\ / : * ? " < > |in titles. - Mermaid fenced blocks generally render.
- Prefer relative wiki links such as
[Architecture](Architecture).
- Managed publisher:
.github/workflows/publish-wiki.yml - Repository-surface control plane:
.github/workflows/reconcile-repository-surface.yml - Reconciliation design:
docs/agentic/repository-surface-reconciliation.md - DeepWiki evidence policy:
docs/agentic/deepwiki-validation.yaml