Conversation
Introduce a repo-focused wiki under docs-md/wiki with topic pages (index, sources, log, system overview, graph-workflows, HITL, auth-and-groups, deployment-and-ops, open-questions) and guidelines (README). Add scripts/scripts: build-docs-wiki.js and validate-wiki.js plus package.json updates to expose the docs:wiki:check script. Add a GitHub Actions workflow (.github/workflows/wiki-check.yml) to run npm run docs:wiki:check on PRs. Integrate generated wiki into the site: update docs build (docs/build.sh) to run the wiki renderer, add nav link and page entries in docs/* HTML, and include generated wiki HTML files (docs/wiki*.html). Also update CLAUDE.md with wiki usage rules. This enables validation, generation, and navigation of the repo wiki from CI and the static docs site.
Add a GitHub Pages workflow and tighten wiki CI checks; introduce AGENTS.md and ARCHIVE.md to canonize repo wiki rules and archival guidance. Rework many docs and READMEs to rename/replace labeling/training with template-models, document graph-workflow and workflow-builder changes, and surface group-scoped API key behavior. Strengthen contributor/copilot guidance (avoid leaking secrets, curl usage with env API_KEY) and update CLAUDE.md accordingly. Ignore generated wiki HTML in .gitignore, remove stale generated wiki HTML files, and update docs build/validation scripts and package.json to support the new pages/wiki workflows.
The canonical Workflow Builder Guide lives under docs-md/workflow-builder/. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Move all active docs into topic folders: architecture/, auth/, groups/, workflows/, extraction/, operations/, monitoring/, benchmarking/, frontend/ - Merge graph-workflows/, workflow-builder/, temporal/ into workflows/ - Archive point-in-time artifacts (temp/ audits, rapid assessment, PR-88 review, load test report, completed plans) under docs-md/archive/ - Rewrite all references across code, READMEs, wiki, and docs site (incl. runtime template paths in apps/shared/prisma/seed.ts) - Add docs-md/README.md taxonomy index; expand archive/README.md policy - Untrack generated docs/wiki*.html (gitignored per PR #198 rules) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Encodes four workflows (Ingest after code changes, Audit accuracy, AddDoc for gaps, Archive stale docs), the docs-md topic taxonomy, and a docs-md-wide relative-link checker script. Referenced from AGENTS.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Verified against code and corrected: audit event catalog, database services map (Actor/Tables modules, method lists), HA resource values, shared packages (7 packages, build chains, Dockerfile patterns), stress run sheet preconditions, benchmarking analysis paths, README taxonomy. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Remove instructions referencing nonexistent .env.sample; point to manual .env creation and the external secrets override (docs-md/operations/local-dev-secrets.md) - Update site index: project structure (ches-adapter, packages/, tools/), docs-md topic-folder references, wiki entrypoint link - Rebuild docs/index.html via docs/build.sh Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… shared packages) Verified against code: classifier deletion sequence (DB-first, orphan-cleanup cron, exact config matching), upload caps, tables pattern file layout and groupId injection, db-service module notes, frontend vite alias caveat, stress-sheet matrix tracker note. Includes partial edits from auditors interrupted by session limits; those docs are re-audited in the follow-up run. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ions) Groups API docs had several wrong endpoints (bulk-assign, get-all, user-membership, leave, request-membership) replaced with actual routes/authorization (@Identity guards, group-admin rules, audit events, ephemeral request rows). Ground-truth/HITL dataset docs: status values, payload shapes, reopen endpoint. Operations deploy docs verified. Includes partial edits from interrupted auditors; remaining verification tracked in the follow-up checklist. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ning-audit checklist - Archive DATABASE_ROLES.md (removed Role/UserRole schema) with routing to current auth docs - Fix remaining repo-root-style links in WORKFLOW_NODE_IO_MODEL_DECISION and OCR_CONFUSION_MATRICES; docs-md link checker now passes clean - Wiki: log entry for the reorg+audit, open-questions follow-ups (AI-1296 Dockerfile package mismatch, extraction topic page, dead actorId field, instance-name test expectations) - Add remaining-audit checklist (56 docs + gap scans) executable via the docs-sync skill / checklist-executor Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ELS)
BLOB_STORAGE: rewrite stale key layout to the group-scoped scheme
({groupId}/{category}/... via @ai-di/blob-storage-paths), remove the
nonexistent 'classification' Azure container (training mirrors primary
keys), fix training container naming (training-{id}-v{n}), document
thumbnail.webp and _shared prefix. TABLES: add year-month column type.
TEMPLATE_MODELS: TRAINING_MIN_DOCUMENTS configurable minimum.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
HITL_ARCHITECTURE and GROUP_RESOURCE_AUTHORIZATION verified accurate. AUTHENTICATION: identity resolution is a single findUserWithGroups query (not two parallel queries), ApiKeyAuthGuard sets request.apiKey (not request.user/apiKeyGroupId), IDOR open issue marked resolved via group-scoped authorization, test example matches MeResponseDto. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
LOAD_TESTING verified accurate. OCR_CONFUSION_MATRICES: derivation is now implemented (confusion-profile module + confusionProfileId on ocr.characterConfusion) - replaced stale 'offline only' status. OCR_IMPROVEMENT_PIPELINE: fixed nonexistent confusion-matrix/derive endpoint (real route is groups/:groupId/confusion-profiles/derive), removed dead OCR-TASK.md reference. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…zation) ENRICHMENT: replaced legacy step-based (steps.enrichResults) config with graph-node parameters; removed nonexistent llmPromptAppend param (also from OCR_IMPROVEMENT_PIPELINE). FIELD_FORMAT_ENGINE: benchmark mismatch integration is shipped, not TODO; documented suggestFromRun. DOCUMENT_IMAGE_NORMALIZATION: blob prefixes updated to group-scoped key scheme. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Verified BC design system migration doc paths/adapters, screen migration status table, and reference-data tables UI (fixed TablesListPage component name). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
SIDEBAR_NAVIGATION rewritten: routing is explicit createBrowserRouter (not a catch-all), sidebar lives in RootLayout, GroupsPage is no longer a placeholder. GroupSelector header location corrected. Bootstrap, selector, membership page, context, and detail docs verified against code. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Helm/PLG, metrics/dashboards, and local/logging docs verified against the plg chart, @ai-di/monitoring metric names, and compose profiles. PROMETHEUS_HELM_CHART: Alertmanager IS included in the chart (stale 'metrics only' note removed). Stray docs/LOGGING.md (March 2026) archived; monitoring/LOGGING.md is canonical. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Env/secrets and infra docs verified: all documented env vars exist in code, manifests, or deploy scripts; referenced scripts and terraform files resolve. Archived docs/LOGGING.md move included previously. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
DAG_WORKFLOW_ENGINE: verified all referenced paths and activity IDs; replaced the historical migration Appendix A with a note (several listed paths never existed or moved to graph-engine/ and packages/). WORKFLOW_NODE_CATALOG: added registry-verified utility activities section (blob.read, tables.lookup, document.* helpers, extractToBase64 blob-path note) and two missing benchmark rows. Remaining workflows docs verified accurate. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Scanned backend/temporal/frontend/packages/ops/CI surfaces against doc coverage. One substantive gap closed: docs-md/operations/CI_WORKFLOWS.md mapping all 14 GitHub Actions workflows (QA, security scans, deploy, manual DB ops, release). Wiki log updated; validator and link checker green. Remaining-audit checklist fully checked off. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Introduces new `.claude` skills for documentation updates and single-PR creation, including detailed workflow guides. Updates AGENTS/CLAUDE/Copilot instructions to route contributors to these skills, and aligns PR checklist language to require docs updates (including wiki updates when routing or boundaries change). Also syncs the split-branch workflow checklist with the updated PR template wording.
Co-authored-by: Cursor <cursoragent@cursor.com>
…ages Both apps declare @ai-di/graph-workflow-config and @ai-di/temporal-payload-codec as file: dependencies, but neither Dockerfile copied/built them, so the builder-stage npm install could not resolve the file: paths. Add COPY + build (no @AI-DI inter-deps, so no symlink needed) in the builder stage and COPY --from=builder in the production stage of both Dockerfiles, matching the existing workspace-package pattern. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…cs-sync - New docs-md/wiki/extraction.md topic page routes the 11 OCR/extraction docs (index + sources registry updated); resolves the extraction-topic open question. Wiki validator now green over 14 pages. - CLAUDE.md docs rule now names the topic-folder taxonomy and the docs-sync skill. - PR template's documentation checklist item now names docs-md/ and the skill (alongside the existing wiki-routing item). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Remove GroupRequest.actorId from useGroups.ts — the backend GroupMembershipRequestDto never returns it (dead optional field); frontend type-checks clean without it. - Align instance-name tests with the deliberate 20-char truncation (the limit was changed 63->20 with a documented Crunchy-operator rationale, but tests 1.4/2.7 still expected pre-truncation values and 2.8/2.9 were mislabeled '63'). Also fix the stale '63 characters' claim in the sanitize_instance_name docstring. Suite: 31/31 pass. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
kmandryk
marked this pull request as ready for review
July 3, 2026 20:12
kmandryk
requested review from
NoorChasib,
alex-struk,
antsand and
dbarkowsky
as code owners
July 3, 2026 20:12
Conflict resolutions: - Dockerfiles (backend, temporal): drop graph-workflow-config COPY/build steps -- base removed that package (consolidated into graph-workflow). - KUSTOMIZE_INSTANCE_TEMPLATE.md: keep the detailed HEAD wording but fix the annotation name ip_whitelist -> ip_allowlist to match the actual base Route manifests (route.yml uses ip_allowlist with the Silver/Gold/Gold DR NAT IPs). - BC_DS_SCREEN_MIGRATION_STATUS.md: keep both the non-adapter-exceptions note and base's 2026-06-26 UI-consistency section (non-overlapping additions). - CLAUDE.md: keep docs-sync skill + topic-folder guidance (matches reorg). - PULL_REQUEST_TEMPLATE.md: keep docs-sync/topic-folder + wiki bullets, fold in base's READMEs / public docs/ site coverage. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
AI-1296: Sync docs-md to codebase, reorganize, add docs-sync skill
Move scattered feature docs into the proper `docs-md` topic folders, fix internal links and agent-rule references, and refresh wiki/source routing to match the new taxonomy. This also updates architecture/workflow docs for current transaction and audit behavior, documents OCR result views and Temporal payload footprint handling, and removes the obsolete Temporal build step for the old `graph-workflow-config` package after its consolidation into `@ai-di/graph-workflow`.
alex-struk
approved these changes
Jul 10, 2026
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
2 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.
Introduce a repo-focused wiki under docs-md/wiki with topic pages (index, sources, log, system overview, graph-workflows, HITL, auth-and-groups, deployment-and-ops, open-questions) and guidelines (README). Add scripts/scripts: build-docs-wiki.js and validate-wiki.js plus package.json updates to expose the docs:wiki:check script. Add a GitHub Actions workflow (.github/workflows/wiki-check.yml) to run npm run docs:wiki:check on PRs. Integrate generated wiki into the site: update docs build (docs/build.sh) to run the wiki renderer, add nav link and page entries in docs/* HTML, and include generated wiki HTML files (docs/wiki*.html). Also update CLAUDE.md with wiki usage rules. This enables validation, generation, and navigation of the repo wiki from CI and the static docs site.
Summary
AI-1296
Changes
Add repo wiki to docs site. repo wiki serves as a documentation compression layer, with the goal of reducing the number of places to search for source of truth documentation. In addition, the wiki/log/sources should be agenticly updated with any changes. A stretch goal after an initial review will be to reduce and consolidate existing documentation.
Testing
Checklist
By submitting this pull request, I acknowledge that I have attempted to meet the following: