Skip to content

docs: rationalize root docs and move guide under docs#32

Merged
flyingrobots merged 3 commits intomainfrom
docs/drop-ibm-design-thinking-name
Apr 1, 2026
Merged

docs: rationalize root docs and move guide under docs#32
flyingrobots merged 3 commits intomainfrom
docs/drop-ibm-design-thinking-name

Conversation

@flyingrobots
Copy link
Copy Markdown
Member

@flyingrobots flyingrobots commented Apr 1, 2026

Summary

  • drop the branded design-process name while keeping the same workflow intent
  • stop tracking local-only evaluation artifacts and remove COMPLETED_TASKS.md
  • add Truth backlog audits for examples, guide accuracy, and markdown-surface rationalization
  • move the long-form guide under docs/ and repair stale public-surface examples and routing

Verification

  • npx prettier --check on touched Markdown files
  • git diff --check
  • pre-commit eslint
  • pre-push npx eslint .
  • pre-push npm test

Summary by CodeRabbit

  • Documentation
    • Relocated and updated the user guide with revised examples, CLI syntax, and architecture guidance
    • Reorganized design and backlog documentation for improved navigation
    • Removed outdated audit and completed tasks documentation
    • Streamlined contribution and workflow documentation

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR reorganizes the repository's documentation structure by archiving outdated audit documents, consolidating completed task tracking into versioned design cycles, moving the long-form guide into the docs directory, updating all cross-references, and revising technical guidance for observability and CLI usage patterns.

Changes

Cohort / File(s) Summary
Documentation Deprecation & Cleanup
.gitignore, CODE-EVAL.md, COMPLETED_TASKS.md
Removed forensic audit and task-tracking documents; added CODE-EVAL.md to gitignore to prevent future inclusion.
Root-Level Reference Updates
CHANGELOG.md, README.md, ROADMAP.md, STATUS.md
Updated links and references to point to new documentation locations (docs/GUIDE.md, docs/design/README.md, docs/archive/BACKLOG/README.md) instead of deleted files.
Terminology Standardization
CONTRIBUTING.md, WORKFLOW.md
Replaced "IBM Design Thinking" terminology with generic "design-thinking" framing; removed references to deleted documentation sources.
Guide Relocation & Technical Updates
docs/GUIDE.md
Moved content to docs subdirectory with significant updates: replaced EventEmitter-based observability with ObservabilityPort pattern, updated CLI syntax to use --oid flag, revised restore-from-tree workflow to use readManifest({ treeOid }), and clarified memory behavior for plaintext vs. encrypted/compressed restores.
New Backlog & Audit Items
docs/BACKLOG/README.md, docs/BACKLOG/TR-012-examples-surface-audit.md, docs/BACKLOG/TR-014-markdown-surface-rationalization.md
Added two new active backlog initiatives: examples surface audit and markdown surface rationalization, each with detailed problem statements and target outcomes.
Archived Backlog & Design Cycles
docs/archive/BACKLOG/README.md, docs/archive/BACKLOG/TR-013-guide-accuracy-audit.md, docs/design/README.md, docs/design/TR-013-guide-accuracy-audit.md
Created design cycle documentation for completed TR-013 guide audit, including technical accuracy findings and implementation record; linked archived backlog entry to truth document.
Design Legend Update
docs/legends/TR-truth.md
Extended current cycle surface with new audit/rationalization backlog items and design-cycle entry; updated focus areas to include guide accuracy maintenance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

🐰 The docs hop onward, left and right,
New burrows built with clarity bright.
Audit trails marked, old guides find home,
Design cycles bloom—no more to roam!
A rabbit's warren, organized with care. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: removing root-level documentation files, rationalizing the docs structure, and moving the guide under docs/.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/drop-ibm-design-thinking-name

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@flyingrobots flyingrobots merged commit 437ce59 into main Apr 1, 2026
5 of 6 checks passed
@flyingrobots flyingrobots deleted the docs/drop-ibm-design-thinking-name branch April 1, 2026 08:59
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