northgale/ckeditor
Watch
12
0
Fork
You've already forked ckeditor
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Reorganize docs into /docs/ tree and add Context-lifecycle plan #51

Manually merged
ebrandt merged 2 commits from feat/051-reorganize-docs-into-docs-tree-and-add-context into master 2026-06-29 14:55:48 +02:00
Conversation 2 Commits 2 Files changed 15 +401 -409
hkowalski commented 2026-06-26 15:43:10 +02:00
Owner
Copy link

Reorganize docs into /docs/ tree and add Context-lifecycle plan

Along the way:

  • Add status banner and updated relationship paths to architecture docs

Touches 8 files: CLAUDE.md, README.md, ck-files/README.md, ck-mcp-editor/README.md, ck-notes/README.md, docs/architecture/ckeditor-ai-integration.md and 2 more.

Reorganize docs into /docs/ tree and add Context-lifecycle plan Along the way: - Add status banner and updated relationship paths to architecture docs Touches 8 files: `CLAUDE.md`, `README.md`, `ck-files/README.md`, `ck-mcp-editor/README.md`, `ck-notes/README.md`, `docs/architecture/ckeditor-ai-integration.md` and 2 more.
ebrandt approved these changes 2026-06-27 16:38:35 +02:00
ebrandt left a comment
Copy link

Happy with this. I ran the suite against the branch and it is green, docs/architecture/ckeditor-context-model.md included.

Happy with this. I ran the suite against the branch and it is green, `docs/architecture/ckeditor-context-model.md` included.
docs/architecture/ckeditor-context-model.md
@ -0,0 +25,4 @@
[`docs/roadmap/ckeditor-extraction-roadmap.md`](../roadmap/ckeditor-extraction-roadmap.md).
Socket conventions shared with
[`docs/features/parked/ckeditor-tmux.md`](../features/parked/ckeditor-tmux.md)
(parked). Quality hardening checklist at
ebrandt commented 2026-06-27 16:38:35 +02:00
Owner
Copy link

I had to read Quality twice. Nothing wrong with it, but one line of comment would save the next person the second read.

I had to read `Quality` twice. Nothing wrong with it, but one line of comment would save the next person the second read.
hkowalski commented 2026-06-28 08:00:00 +02:00
Author
Owner
Copy link

Comment added on Quality in docs/architecture/ckeditor-context-model.md. It was obvious when I wrote it and it will not be in a month.

Comment added on `Quality` in `docs/architecture/ckeditor-context-model.md`. It was obvious when I wrote it and it will not be in a month.
- Move design docs into docs/architecture/, docs/roadmap/, docs/features/
  by category; rename plan.md to quality-hardening.md.
- Add docs/roadmap/ckeditor-project-lifecycle.md — the design for the
  next refactor: close the Context lifecycle API on Project, remove
  MainCheckout, introduce a user-set root_branch.
- Drop the superseded ckeditor-files-review.md.
- Rewrite root README.md (was empty) with status, doc map, crate table,
  and where-to-start reading path.
- Replace CLAUDE.md "Planning docs" with a Documentation map section;
  flag the active Context-lifecycle refactor in the Project/Context
  section so readers know the feature is not done.
- Add a status banner to docs/architecture/ckeditor-context-model.md
  pointing at the lifecycle plan.
- Fix four broken markdown links in ck-files / ck-mcp-editor / ck-notes
  READMEs that pointed at the old top-level doc paths.
The previous commit captured the file renames but missed the content
edits to docs/architecture/ckeditor-context-model.md and
docs/architecture/ckeditor-ai-integration.md (they were unstaged).

- ckeditor-context-model.md: replace stale "design, pre-implementation"
  banner with current status — foundation landed, Context feature not
  done, with an explicit pointer at the lifecycle plan.
- ckeditor-ai-integration.md: update relationship-to-other-docs paths
  for the new docs/ tree layout; rename plan.md to quality-hardening.md.
ebrandt manually merged commit a3b3a0da8c into master 2026-06-29 14:55:48 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
ebrandt
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
northgale/ckeditor!51
No description provided.