Reorganize docs folder into guides, architecture, features, and research#1750
Open
johan-bell wants to merge 2 commits into
Open
Reorganize docs folder into guides, architecture, features, and research#1750johan-bell wants to merge 2 commits into
johan-bell wants to merge 2 commits into
Conversation
6 tasks
Contributor
Review summary — 🟡 Approve with nitsClean, well-executed docs reorg; two pre-existing broken links carried forward rather than fixed.
🤖 AI-assisted review summary (Claude Code). Read-only analysis of the PR diff — not a substitute for human review. |
Move flat docs/ files into a clearer hierarchy, add docs/README.md index, archive historical-upgrades stub, consolidate project-automation guide, and update cross-repo references to the new paths. Co-authored-by: Cursor <cursoragent@cursor.com>
johan-bell
force-pushed
the
1749-docs-reorganizing-documents-of-the-project
branch
from
55cc4ca to
3db899d
Compare
ivanslabbert
reviewed
Jul 6, 2026
ivanslabbert
left a comment
ivanslabbert
left a comment
Contributor
There was a problem hiding this comment.
added a few comments. But I think we should generally move away from a separate docs folder (except perhaps for a few diagrams like the data model, permission system etc. diagrams).
Documentation describing the actual implementation should live in the app / cms / api / shared library codebases, referenced from the main README of the individual folder.
The projects root level's README serves as the springboard into all the sub-project's documentation, and everything should be reachable by drilling down into sub-project readme files, and drilling down into individual functions
…cross-cutting content Per Ivan's review: docs/ now holds only ADRs, cross-cutting guides, and architecture diagrams. Vue-plugin-architecture moves to app/docs/, rest-api/socket-io-messages/s3-multi-bucket move to api/docs/, api-testing folds into api/README.md, the stale post-checkout git-hook doc is removed (hook script was already deleted from the repo), and docs/research/fts/ (superseded by ADR 0009) is deleted.
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
3 participants
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.
Move flat docs/ files into a clearer hierarchy, add docs/README.md index, archive historical-upgrades stub, consolidate project-automation guide, and update cross-repo references to the new paths.