docs: convert DESIGN.md into wiki landing + add wiki draft pages#82
Merged
docs: convert DESIGN.md into wiki landing + add wiki draft pages#82
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Converts DESIGN.md from a long-form design spec into a stable landing/TOC that points to the GitHub Wiki, and adds a set of draft wiki pages under docs/wiki-draft/ to serve as the initial wiki structure.
Changes:
- Replaces
DESIGN.mdcontent with a short wiki-index landing page. - Adds draft wiki pages covering architecture, retrieval, ingestion, consolidation, storage, security, performance, terminology, and math.
- Updates contributor/docs entry points (README, development docs, Copilot instructions, issue template link) to treat the wiki as canonical.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/wiki-draft/Terminology.md | Adds terminology + numerics page; includes references to policy/model-derived constants. |
| docs/wiki-draft/Storage.md | Adds storage overview (OPFS vectors + IndexedDB metadata). |
| docs/wiki-draft/Security.md | Adds security/trust overview and sharing guardrails references. |
| docs/wiki-draft/Retrieval.md | Adds retrieval + Metroid overview and knowledge-gap description. |
| docs/wiki-draft/Performance.md | Adds Williams-bound performance/budgeting overview. |
| docs/wiki-draft/Math-Appendix.md | Adds math appendix (curse of dimensionality + sublinear bound). |
| docs/wiki-draft/Ingestion.md | Adds ingestion pipeline overview (chunk/embed/neighbor insert/hierarchy). |
| docs/wiki-draft/Home.md | Adds wiki home/TOC page for the draft wiki set. |
| docs/wiki-draft/Consolidation.md | Adds Daydreamer consolidation overview. |
| docs/wiki-draft/Architecture.md | Adds high-level architecture overview and core concept definitions. |
| docs/development.md | Updates doc-maintenance workflow to include wiki updates as canonical. |
| README.md | Updates documentation table to link to the wiki as canonical design documentation. |
| DESIGN.md | Replaces full spec with a short landing/TOC into wiki pages. |
| .github/copilot-instructions.md | Updates documentation guidance to keep wiki + DESIGN.md in sync. |
| .github/ISSUE_TEMPLATE/config.yml | Updates “Architecture Reference” link to the wiki. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
This PR trims the repo's into a lightweight design landing / TOC page and adds a set of drafted wiki pages under .\n\n### Key changes\n- becomes a stable TOC/landing page pointing at the GitHub Wiki.\n- Added a draft wiki structure (Home + architecture/retrieval/ingestion/etc.) in .\n- Updated docs and templates to point at the wiki as the canonical design source.\n\n### Notes\n- The wiki repo itself could not be cloned from this environment (still localized to ). Once the wiki repo is accessible, these pages can be copied into it.\n- This PR is on branch .\n