Repository navigation
docs: deduplicate, trim and resync the repo documentation - #373
Merged
Merged
Conversation
Fix drift against the code across api.md, data-model.md, engineering.md, README and CONTRIBUTING; share one event-form table in api.md; move the hand-kept FE/BE mirror list from AGENTS.md into an engineering.md table; compress design.md and video/README; remove internal figures and personal fixture values from public docs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: vidit-admin <admin@vidit.app>
…ion-cleanup-5692f1 Signed-off-by: vidit-admin <admin@vidit.app> # Conflicts: # AGENTS.md # docs/engineering.md
vidit-admin
force-pushed
the
claude/doc-deduplication-cleanup-5692f1
branch
from
October 3, 2026 23:09
78ed076 to
b5f44d2
Compare
…ion-cleanup-5692f1 Signed-off-by: vidit-admin <admin@vidit.app> # Conflicts: # docs/engineering.md
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
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.
Summary
Doc-only cleanup across
docs/, the root meta files, the GitHub templates andvideo/README.md. About 2,150 lines removed and 1,370 added;docs/api.mddrops from 24,800 to 15,400 words.POST /tagsduplicate behaviour, response examples, the pagination scope; the data-model.md ER diagram (4 missing tables,conflicts.tier),uuid4primary keys, a stale migration id; the engineering.md Postgres version, auth wall, docs-pairing exemption, MkDocs deploy; the README invite flow; the CONTRIBUTING CI job list; the PR template anchors.engineering.md#hand-kept-mirrorstable; README links to engineering.md and CONTRIBUTING instead of repeating them; bucket facts live in backups.md.record-*.jsheader comments (comments only).--size 1500, since mermaid-cli 12 rejects-w.planning/is out of scope for this PR.Test plan
node --checkpasses on the editedvideo/record-*.jsfiles.🤖 Generated with Claude Code