Skip to content

docs: deduplicate, trim and resync the repo documentation - #373

Merged
vidit-admin merged 3 commits into
mainfrom
claude/doc-deduplication-cleanup-5692f1
Oct 4, 2026
Merged

vidit-admin merged 3 commits into
mainfrom
claude/doc-deduplication-cleanup-5692f1

Conversation

@vidit-admin

Copy link
Copy Markdown
Member

Summary

Doc-only cleanup across docs/, the root meta files, the GitHub templates and video/README.md. About 2,150 lines removed and 1,370 added; docs/api.md drops from 24,800 to 15,400 words.

  • Drift fixes, each checked against the code: the api.md error envelope and codes, the read-quota list, the POST /tags duplicate behaviour, response examples, the pagination scope; the data-model.md ER diagram (4 missing tables, conflicts.tier), uuid4 primary 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.
  • Deduplication: one shared event-form field table and error table in api.md, one example per schema, rate limits stated once; the FE/BE mirror list moves from AGENTS.md into the engineering.md#hand-kept-mirrors table; README links to engineering.md and CONTRIBUTING instead of repeating them; bucket facts live in backups.md.
  • Trimming: design.md compressed with every rule kept; video/README reduced to one table row per promo, with the shooting rationale moved into the record-*.js header comments (comments only).
  • Public-doc hygiene: removes hosting costs, user counts, monetization intent and personal fixture values; removes history narrative and dashes used as punctuation.
  • New diagrams: the api.md request pipeline and event lifecycle, the backups.md flow, the design.md collections flow; all render with mermaid-cli. The AGENTS.md render command now uses --size 1500, since mermaid-cli 12 rejects -w.

planning/ is out of scope for this PR.

Test plan

  • Every relative link and anchor in the changed docs resolves (script check).
  • Every added or edited Mermaid diagram renders locally.
  • node --check passes on the edited video/record-*.js files.

🤖 Generated with Claude Code

vidit-admin and others added 2 commits October 4, 2026 01:08
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
vidit-admin force-pushed the claude/doc-deduplication-cleanup-5692f1 branch from 78ed076 to b5f44d2 Compare October 3, 2026 23:09
@vidit-admin vidit-admin added the no-docs-needed Exempts the docs-pairing CI check (PR with no docs/ + planning/ impact) label Oct 4, 2026
…ion-cleanup-5692f1

Signed-off-by: vidit-admin <admin@vidit.app>

# Conflicts:
#	docs/engineering.md
@vidit-admin
vidit-admin merged commit f325969 into main Oct 4, 2026
13 checks passed
@vidit-admin
vidit-admin deleted the claude/doc-deduplication-cleanup-5692f1 branch October 4, 2026 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-docs-needed Exempts the docs-pairing CI check (PR with no docs/ + planning/ impact)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant