mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-07-03 12:27:41 +08:00

Files

fullex c060e867f2 docs(v2-refactor-temp): add cross-cutting v2 refactor TODO tracker

Add v2-todo.md tracking whole-refactor tasks: v1 data-stack and UI-library
teardown, migrator and schema finalization, removal-slated @deprecated sites,
and release cleanup. Link it from the directory README.

2026-05-31 19:35:46 -07:00

2.5 KiB

Raw Permalink Blame History

V2 Refactor Temp Directory

Working directory for the Cherry Studio v2 data and UI refactor. Holds shared tools, working notes, and other transient artifacts used during the refactor.

Important: This directory will be removed after the v2 refactor lands.

Layout

v2-refactor-temp/
├── tools/                    # Refactor tooling
│   └── data-classify/        # Data classification and code generation
├── docs/                     # Working notes
│   ├── v2-todo.md            # Cross-cutting global v2-refactor TODO tracker
│   ├── breaking-changes.md   # V2 breaking changes index
│   └── breaking-changes/     # Individual breaking change records
└── README.md                 # This file

Tools (`tools/`)

data-classify/ — Data classification and code generation pipeline
- Extracts the data inventory from source
- Manages classification mappings
- Generates TypeScript types and migration mappings
- See tools/data-classify/README.md

Docs (`docs/`)

v2-todo.md — Cross-cutting global v2-refactor TODO tracker
- Tracks whole-refactor tasks only: v1 data-stack and UI-library teardown, migrator and schema finalization, removal-slated @deprecated sites, release cleanup
- Per-module fine-grained TODOs stay in their own docs and are not duplicated here
- See docs/v2-todo.md
breaking-changes.md — Index of v2 user-perceivable breaking changes
- Any removed capability, incompatible data shape, migration downgrade, or user-visible behavior change should add an individual document and update this index
- See docs/breaking-changes.md
breaking-changes/ — Log of v2 changes that affect how users use the app
- PR authors drop an entry alongside their PR; the release manager aggregates and translates these into the Chinese user-facing release note at v2.0.0
- See docs/breaking-changes/README.md

Usage notes

This directory contains no production code — it only supports the refactor
Generated code is written to the canonical project locations, not here
Do not store anything that needs to be preserved long-term

Cleanup plan

After the v2 refactor lands, remove this directory entirely:

Confirm all tooling here is no longer needed
Move any documents worth keeping to their canonical locations
Delete the v2-refactor-temp/ directory
Update .gitignore and any remaining references

2.5 KiB Raw Permalink Blame History