ticket: use base32 project record ids

This commit is contained in:
2026-06-09 22:10:47 +09:00
parent 0803bc3725
commit 4203988d74
798 changed files with 477 additions and 105 deletions
@@ -0,0 +1,32 @@
# Implementation report
## Summary
Reorganized maintained repository documentation around current Yoi design intent and development workflow.
## Changes
- Replaced the root `README.md` with a concise developer entry point.
- Added `docs/README.md` as the documentation map and contribution boundary.
- Added maintained design docs under `docs/design/`:
- `overview.md`
- `pod-session-state.md`
- `context-history.md`
- `profiles-manifests-prompts.md`
- `tool-permissions-scope.md`
- `memory-knowledge.md`
- `compaction.md`
- `provider-model-boundary.md`
- Added maintained development docs under `docs/development/`:
- `work-items.md`
- `workflows.md`
- `validation.md`
- `dogfooding.md`
- `environment.md`
- Moved old top-level docs, `docs/plan/`, `docs/ref/`, and `docs/research/` material into ignored `docs/.local/old-docs/` so the repository documentation surface no longer presents it as current authority.
## Validation
- `./tickets.sh doctor` => `doctor: ok`
- `git diff --check` => passed
- stale-surface grep over `README.md`, maintained `docs/`, and crate READMEs excluding `docs/report/` and `docs/.local/` => no output
+28
View File
@@ -0,0 +1,28 @@
---
title: "Reorganize documentation information architecture"
state: "closed"
created_at: "2026-06-01T11:00:26Z"
updated_at: "2026-06-01T13:22:50Z"
---
## Background
The repository documentation still mixes current design intent, historical plans, external research, and implementation notes. The next documentation pass should make the maintained docs answer why Yoi is shaped this way, while moving or deleting research/log material that is not useful as stable developer documentation.
This work item covers the top-level documentation information architecture only. Crate-level README cleanup is tracked separately by `crate-readme-boundaries`.
## Requirements
- Keep repository documentation focused on current Yoi design intent and development workflow.
- Prefer durable Why over implementation details that code, tickets, or git history already own.
- Do not preserve stale plan/research material merely because it exists.
- Treat `docs/.local/` as the home for private or non-authoritative notes that should not be part of the public documentation surface.
## Acceptance criteria
- Root `README.md` points developers to the maintained documentation map.
- Maintained design docs live under `docs/design/` and cover the major Yoi design boundaries.
- Maintained development workflow docs live under `docs/development/`.
- `docs/ref/` and `docs/research/` are no longer part of the repository documentation surface.
- `docs/plan/` is removed or reduced so old plans are not mistaken for current design authority.
- Validation includes `./tickets.sh doctor` and `git diff --check`.
+1
View File
@@ -0,0 +1 @@
Completed documentation information architecture cleanup: root and docs README now define maintained docs surface; design/development docs added; old plan/ref/research/top-level docs moved out of maintained surface; validation passed.
+56
View File
@@ -0,0 +1,56 @@
<!-- event: create author: tickets.sh at: 2026-06-01T11:00:26Z -->
## Created
Created by tickets.sh create.
---
<!-- event: implementation_report author: hare at: 2026-06-01T11:09:35Z -->
## Implementation report
# Implementation report
## Summary
Reorganized maintained repository documentation around current Yoi design intent and development workflow.
## Changes
- Replaced the root `README.md` with a concise developer entry point.
- Added `docs/README.md` as the documentation map and contribution boundary.
- Added maintained design docs under `docs/design/`:
- `overview.md`
- `pod-session-state.md`
- `context-history.md`
- `profiles-manifests-prompts.md`
- `tool-permissions-scope.md`
- `memory-knowledge.md`
- `compaction.md`
- `provider-model-boundary.md`
- Added maintained development docs under `docs/development/`:
- `work-items.md`
- `workflows.md`
- `validation.md`
- `dogfooding.md`
- `environment.md`
- Moved old top-level docs, `docs/plan/`, `docs/ref/`, and `docs/research/` material into ignored `docs/.local/old-docs/` so the repository documentation surface no longer presents it as current authority.
## Validation
- `./tickets.sh doctor` => `doctor: ok`
- `git diff --check` => passed
- stale-surface grep over `README.md`, maintained `docs/`, and crate READMEs excluding `docs/report/` and `docs/.local/` => no output
---
<!-- event: close author: hare at: 2026-06-01T13:22:50Z status: closed -->
## Closed
Completed documentation information architecture cleanup: root and docs README now define maintained docs surface; design/development docs added; old plan/ref/research/top-level docs moved out of maintained surface; validation passed.
---