Skip to content

docs: establish coauthoring program and taxonomy - #134

Merged
kl3inIT merged 2 commits into
mainfrom
agent/docs-authoring-program
Jul 29, 2026
Merged

docs: establish coauthoring program and taxonomy#134
kl3inIT merged 2 commits into
mainfrom
agent/docs-authoring-program

Conversation

@kl3inIT

@kl3inIT kl3inIT commented Jul 29, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace sparse audience roots with Getting Started, Guides, Architecture & Security, and Reference
  • preserve moved EN/VI HTML and Markdown URLs with permanent redirects
  • record the owner-led, one-page-at-a-time coauthoring program and local-first review loop
  • close the delivered public portal increment and keep the new coauthoring program active

Verification

  • corepack pnpm --filter @orgmemory/docs check
  • corepack pnpm --filter @orgmemory/docs test:e2e — 23 passed, 3 intentional skips
  • corepack pnpm --filter @orgmemory/docs check:output
  • python scripts/check_docs.py
  • git diff --check
  • corepack pnpm docs:dev + local /healthz = 200 ok

Coauthoring boundary

This PR changes structure and delivery contracts only. It does not bulk-rewrite or translate content. The next content increment pauses for owner context and outline approval before editing What is OrgMemory?.

Summary by CodeRabbit

  • New Features

    • Added Getting Started content, including core concepts.
    • Added administration, source connections, Assistant/MCP integration, and governed asset lifecycle guides.
    • Added expanded API reference pages for platform, assets, administration, search, assistant, and knowledge graph capabilities.
    • Added English and Vietnamese navigation for the new documentation structure.
  • Documentation

    • Reorganized documentation into Getting Started, Guides, Architecture & Security, and Reference.
    • Added local-first authoring and draft-preview guidance.
  • Bug Fixes

    • Added permanent redirects from legacy documentation URLs to their new locations.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@kl3inIT, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 208254a7-595b-4fda-9cff-750a005ab661

📥 Commits

Reviewing files that changed from the base of the PR and between 0be1454 and 797cb41.

📒 Files selected for processing (2)
  • apps/docs/AUTHORING.md
  • apps/docs/README.md
📝 Walkthrough

Walkthrough

The docs app is reorganized into Getting Started, Guides, Architecture & Security, and Reference sections. New authoring guidance, conceptual and operational pages, generated API references, route redirects, localized metadata, local development instructions, and navigation tests are added or updated.

Changes

Documentation authoring and local development

Layer / File(s) Summary
Authoring workflow and local development
apps/docs/AUTHORING.md, apps/docs/ARCHITECTURE.md, apps/docs/CLAUDE.md, apps/docs/README.md, package.json
Adds authoring agreements, queue and review checkpoints, local-first docs workflows, draft preview instructions, and a dedicated docs:dev script.

Navigation taxonomy and foundational content

Layer / File(s) Summary
Navigation taxonomy and foundational content
apps/docs/content/docs/meta*.json, apps/docs/content/docs/getting-started/*, apps/docs/content/docs/guides/meta*.json, apps/docs/content/docs/architecture-security/*, apps/docs/content/docs/reference/meta*.json
Replaces legacy root sections with the new taxonomy, adds localized metadata, and introduces Core concepts plus the governed Asset lifecycle page.
Guide section metadata
apps/docs/content/docs/guides/administration/meta*, apps/docs/content/docs/guides/deployment-operations/meta*, apps/docs/content/docs/guides/integrations/meta*
Renames and nests guide sections, adds page lists, and updates localized section metadata.

Operational guides

Layer / File(s) Summary
Administration and integration guides
apps/docs/content/docs/guides/administration/*.mdx, apps/docs/content/docs/guides/integrations/*.mdx
Documents identity and permission administration, source connections, Assistant behavior, MCP authentication, asset delivery, Skill CLI handling, and verification boundaries.

Generated API reference

Layer / File(s) Summary
Generated API reference relocation
apps/docs/content/docs/reference/api-reference/*, apps/docs/generated-api.manifest.json, apps/docs/scripts/generate-openapi.ts
Adds generated reference pages and moves generated routes, content paths, manifest areas, and stale-content cleanup from developers to reference.

Routing and validation

Layer / File(s) Summary
Routing, styling, manifests, and navigation validation
apps/docs/next.config.mjs, apps/docs/public-content.manifest.json, apps/docs/src/app/**, apps/docs/src/lib/*, apps/docs/test/e2e/navigation.spec.ts
Updates default docs routing, category styling, published routes, permanent legacy redirects, localized navigation, and end-to-end route assertions.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the main change: a docs coauthoring program plus a revised taxonomy.
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/docs-authoring-program

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@kl3inIT
kl3inIT marked this pull request as ready for review July 29, 2026 15:00

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/docs/content/docs/architecture-security/meta.vi.json`:
- Around line 7-8: Remove the "asset-lifecycle" entry from the Vietnamese
navigation list in meta.vi.json, leaving "system-description" and the remaining
entries unchanged until a reviewed Vietnamese translation is available.

In `@apps/docs/README.md`:
- Around line 9-14: Update apps/docs/README.md lines 9-14 to keep docs:dev out
of the sequential command block by directing authors to run it in a separate
terminal or background it before check and build; update apps/docs/README.md
lines 25-31 and apps/docs/AUTHORING.md lines 38-44 to explicitly stop the
preview server before removing DOCS_INCLUDE_DRAFTS, applying the same cleanup
workflow in both guides.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 293cc1da-696e-4e51-b1b8-6854baf9508b

📥 Commits

Reviewing files that changed from the base of the PR and between fb1c176 and 0be1454.

⛔ Files ignored due to path filters (7)
  • docs/increments/active/2026-07-29-public-docs-coauthoring/design.md is excluded by !docs/**
  • docs/increments/active/2026-07-29-public-docs-coauthoring/plan.md is excluded by !docs/**
  • docs/increments/active/2026-07-29-public-docs-coauthoring/verification.md is excluded by !docs/**
  • docs/increments/completed/2026-07-28-public-docs-portal/design.md is excluded by !docs/**
  • docs/increments/completed/2026-07-28-public-docs-portal/plan.md is excluded by !docs/**
  • docs/increments/completed/2026-07-28-public-docs-portal/verification.md is excluded by !docs/**
  • docs/roadmap.md is excluded by !docs/**
📒 Files selected for processing (53)
  • apps/docs/ARCHITECTURE.md
  • apps/docs/AUTHORING.md
  • apps/docs/CLAUDE.md
  • apps/docs/README.md
  • apps/docs/content/docs/architecture-security/asset-lifecycle.mdx
  • apps/docs/content/docs/architecture-security/evaluation/traceability.mdx
  • apps/docs/content/docs/architecture-security/meta.json
  • apps/docs/content/docs/architecture-security/meta.vi.json
  • apps/docs/content/docs/developers/meta.json
  • apps/docs/content/docs/developers/meta.vi.json
  • apps/docs/content/docs/getting-started/core-concepts.mdx
  • apps/docs/content/docs/getting-started/index.mdx
  • apps/docs/content/docs/getting-started/meta.json
  • apps/docs/content/docs/getting-started/meta.vi.json
  • apps/docs/content/docs/getting-started/quickstart.mdx
  • apps/docs/content/docs/guides/administration/identity-permissions.mdx
  • apps/docs/content/docs/guides/administration/meta.json
  • apps/docs/content/docs/guides/administration/meta.vi.json
  • apps/docs/content/docs/guides/administration/sources-connections.mdx
  • apps/docs/content/docs/guides/deployment-operations/meta.json
  • apps/docs/content/docs/guides/deployment-operations/meta.vi.json
  • apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx
  • apps/docs/content/docs/guides/integrations/assistant-mcp.mdx
  • apps/docs/content/docs/guides/integrations/meta.json
  • apps/docs/content/docs/guides/integrations/meta.vi.json
  • apps/docs/content/docs/guides/meta.json
  • apps/docs/content/docs/guides/meta.vi.json
  • apps/docs/content/docs/meta.json
  • apps/docs/content/docs/meta.vi.json
  • apps/docs/content/docs/overview/meta.json
  • apps/docs/content/docs/overview/meta.vi.json
  • apps/docs/content/docs/reference/api-reference/administration.mdx
  • apps/docs/content/docs/reference/api-reference/assets.mdx
  • apps/docs/content/docs/reference/api-reference/assistant.mdx
  • apps/docs/content/docs/reference/api-reference/authentication.mdx
  • apps/docs/content/docs/reference/api-reference/index.mdx
  • apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx
  • apps/docs/content/docs/reference/api-reference/meta.json
  • apps/docs/content/docs/reference/api-reference/platform.mdx
  • apps/docs/content/docs/reference/api-reference/search-catalog.mdx
  • apps/docs/content/docs/reference/api-reference/sources-connections.mdx
  • apps/docs/content/docs/reference/meta.json
  • apps/docs/content/docs/reference/meta.vi.json
  • apps/docs/generated-api.manifest.json
  • apps/docs/next.config.mjs
  • apps/docs/public-content.manifest.json
  • apps/docs/scripts/generate-openapi.ts
  • apps/docs/src/app/[lang]/docs/[[...slug]]/page.tsx
  • apps/docs/src/app/global.css
  • apps/docs/src/lib/docs-category.ts
  • apps/docs/src/lib/i18n.ts
  • apps/docs/test/e2e/navigation.spec.ts
  • package.json
💤 Files with no reviewable changes (5)
  • apps/docs/content/docs/overview/meta.json
  • apps/docs/content/docs/developers/meta.json
  • apps/docs/content/docs/developers/meta.vi.json
  • apps/docs/content/docs/overview/meta.vi.json
  • apps/docs/content/docs/guides/deployment-operations/meta.vi.json
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: Web · Node 24
  • GitHub Check: Public docs · Node 24
🧰 Additional context used
📓 Path-based instructions (5)
**/*

📄 CodeRabbit inference engine (CLAUDE.md)

**/*: Always read the repository guidance and relevant sections of ARCHITECTURE.md; before changing a domain, read its specification, test-coverage document, and binding decision filenames.
Treat the repository as the engineering system of record; current repository and runtime evidence take precedence over chat or Northstar.
Read docs/guidelines/agent-safety.md before retrieval, AI, MCP, permission, upload, graph, or export work. Never commit secrets or customer data.

Files:

  • apps/docs/content/docs/guides/integrations/meta.vi.json
  • apps/docs/content/docs/architecture-security/meta.vi.json
  • apps/docs/content/docs/reference/meta.json
  • apps/docs/src/app/[lang]/docs/[[...slug]]/page.tsx
  • package.json
  • apps/docs/content/docs/architecture-security/evaluation/traceability.mdx
  • apps/docs/content/docs/meta.json
  • apps/docs/content/docs/guides/meta.vi.json
  • apps/docs/content/docs/getting-started/meta.json
  • apps/docs/content/docs/getting-started/quickstart.mdx
  • apps/docs/content/docs/reference/meta.vi.json
  • apps/docs/content/docs/guides/integrations/meta.json
  • apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx
  • apps/docs/content/docs/reference/api-reference/meta.json
  • apps/docs/content/docs/reference/api-reference/authentication.mdx
  • apps/docs/src/lib/i18n.ts
  • apps/docs/content/docs/getting-started/meta.vi.json
  • apps/docs/content/docs/getting-started/core-concepts.mdx
  • apps/docs/content/docs/guides/meta.json
  • apps/docs/content/docs/guides/administration/meta.json
  • apps/docs/content/docs/meta.vi.json
  • apps/docs/README.md
  • apps/docs/content/docs/architecture-security/asset-lifecycle.mdx
  • apps/docs/content/docs/reference/api-reference/platform.mdx
  • apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx
  • apps/docs/public-content.manifest.json
  • apps/docs/content/docs/architecture-security/meta.json
  • apps/docs/content/docs/reference/api-reference/assistant.mdx
  • apps/docs/content/docs/reference/api-reference/assets.mdx
  • apps/docs/content/docs/reference/api-reference/administration.mdx
  • apps/docs/src/app/global.css
  • apps/docs/AUTHORING.md
  • apps/docs/ARCHITECTURE.md
  • apps/docs/content/docs/reference/api-reference/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/search-catalog.mdx
  • apps/docs/generated-api.manifest.json
  • apps/docs/content/docs/guides/deployment-operations/meta.json
  • apps/docs/content/docs/guides/administration/meta.vi.json
  • apps/docs/content/docs/guides/administration/sources-connections.mdx
  • apps/docs/src/lib/docs-category.ts
  • apps/docs/content/docs/reference/api-reference/index.mdx
  • apps/docs/content/docs/guides/administration/identity-permissions.mdx
  • apps/docs/content/docs/getting-started/index.mdx
  • apps/docs/content/docs/guides/integrations/assistant-mcp.mdx
  • apps/docs/scripts/generate-openapi.ts
  • apps/docs/next.config.mjs
  • apps/docs/test/e2e/navigation.spec.ts
  • apps/docs/CLAUDE.md
apps/docs/**/meta{,.vi}.json

📄 CodeRabbit inference engine (apps/docs/CLAUDE.md)

Keep root-folder names and descriptions aligned between meta.json and meta.vi.json; these files define the sidebar documentation switcher.

Files:

  • apps/docs/content/docs/guides/integrations/meta.vi.json
  • apps/docs/content/docs/architecture-security/meta.vi.json
  • apps/docs/content/docs/reference/meta.json
  • apps/docs/content/docs/meta.json
  • apps/docs/content/docs/guides/meta.vi.json
  • apps/docs/content/docs/getting-started/meta.json
  • apps/docs/content/docs/reference/meta.vi.json
  • apps/docs/content/docs/guides/integrations/meta.json
  • apps/docs/content/docs/reference/api-reference/meta.json
  • apps/docs/content/docs/getting-started/meta.vi.json
  • apps/docs/content/docs/guides/meta.json
  • apps/docs/content/docs/guides/administration/meta.json
  • apps/docs/content/docs/meta.vi.json
  • apps/docs/content/docs/architecture-security/meta.json
  • apps/docs/content/docs/guides/deployment-operations/meta.json
  • apps/docs/content/docs/guides/administration/meta.vi.json
**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{js,jsx,ts,tsx}: Frontend verification must include lint, typecheck, tests, production build, and browser verification when the flow matters.
Before using unfamiliar React, Vite, Tailwind, TypeScript, Next.js, or Fumadocs APIs, consult current official documentation, Context7, and the relevant project verification skill.

Files:

  • apps/docs/src/app/[lang]/docs/[[...slug]]/page.tsx
  • apps/docs/src/lib/i18n.ts
  • apps/docs/src/lib/docs-category.ts
  • apps/docs/scripts/generate-openapi.ts
  • apps/docs/test/e2e/navigation.spec.ts
apps/docs/**/*.{js,jsx,ts,tsx,md,mdx}

📄 CodeRabbit inference engine (apps/docs/CLAUDE.md)

Verify unfamiliar Next.js and Fumadocs APIs against current official documentation or installed dependency types before using them.

Files:

  • apps/docs/src/app/[lang]/docs/[[...slug]]/page.tsx
  • apps/docs/content/docs/architecture-security/evaluation/traceability.mdx
  • apps/docs/content/docs/getting-started/quickstart.mdx
  • apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx
  • apps/docs/content/docs/reference/api-reference/authentication.mdx
  • apps/docs/src/lib/i18n.ts
  • apps/docs/content/docs/getting-started/core-concepts.mdx
  • apps/docs/README.md
  • apps/docs/content/docs/architecture-security/asset-lifecycle.mdx
  • apps/docs/content/docs/reference/api-reference/platform.mdx
  • apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx
  • apps/docs/content/docs/reference/api-reference/assistant.mdx
  • apps/docs/content/docs/reference/api-reference/assets.mdx
  • apps/docs/content/docs/reference/api-reference/administration.mdx
  • apps/docs/AUTHORING.md
  • apps/docs/ARCHITECTURE.md
  • apps/docs/content/docs/reference/api-reference/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/search-catalog.mdx
  • apps/docs/content/docs/guides/administration/sources-connections.mdx
  • apps/docs/src/lib/docs-category.ts
  • apps/docs/content/docs/reference/api-reference/index.mdx
  • apps/docs/content/docs/guides/administration/identity-permissions.mdx
  • apps/docs/content/docs/getting-started/index.mdx
  • apps/docs/content/docs/guides/integrations/assistant-mcp.mdx
  • apps/docs/scripts/generate-openapi.ts
  • apps/docs/test/e2e/navigation.spec.ts
  • apps/docs/CLAUDE.md
apps/docs/content/docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (apps/docs/CLAUDE.md)

apps/docs/content/docs/**/*.{md,mdx}: Public prose must live only in apps/docs/content/docs; internal engineering documents are source evidence, not publication input.
Every documentation page must be listed in apps/docs/public-content.manifest.json and include the required typed frontmatter.
sourceRefs is build-time traceability metadata and must never be rendered in public page content.
Draft pages must remain excluded unless DOCS_INCLUDE_DRAFTS=true is set for a local or controlled preview.
English pages use page.mdx at /docs/...; Vietnamese translations must be added one reviewed page at a time as page.vi.mdx at /vi/docs/.... Do not bulk-copy or machine-publish untranslated pages.

Files:

  • apps/docs/content/docs/architecture-security/evaluation/traceability.mdx
  • apps/docs/content/docs/getting-started/quickstart.mdx
  • apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx
  • apps/docs/content/docs/reference/api-reference/authentication.mdx
  • apps/docs/content/docs/getting-started/core-concepts.mdx
  • apps/docs/content/docs/architecture-security/asset-lifecycle.mdx
  • apps/docs/content/docs/reference/api-reference/platform.mdx
  • apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx
  • apps/docs/content/docs/reference/api-reference/assistant.mdx
  • apps/docs/content/docs/reference/api-reference/assets.mdx
  • apps/docs/content/docs/reference/api-reference/administration.mdx
  • apps/docs/content/docs/reference/api-reference/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/search-catalog.mdx
  • apps/docs/content/docs/guides/administration/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/index.mdx
  • apps/docs/content/docs/guides/administration/identity-permissions.mdx
  • apps/docs/content/docs/getting-started/index.mdx
  • apps/docs/content/docs/guides/integrations/assistant-mcp.mdx
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
Repo: kl3inIT/OrgMemory

Timestamp: 2026-07-29T14:57:29.065Z
Learning: Follow the page queue and co-authoring checkpoints in `apps/docs/AUTHORING.md`; pause content work for owner context, outline approval, and teach-back, and do not autonomously publish multiple pages.
Learnt from: CR
Repo: kl3inIT/OrgMemory

Timestamp: 2026-07-29T14:57:29.065Z
Learning: Before handoff, run `pnpm --filter orgmemory/docs check` and `pnpm --filter orgmemory/docs build`.
📚 Learning: 2026-07-28T20:06:14.930Z
Learnt from: kl3inIT
Repo: kl3inIT/OrgMemory PR: 112
File: apps/docs/content/docs/developers/api-reference/administration.mdx:11-11
Timestamp: 2026-07-28T20:06:14.930Z
Learning: In OrgMemory public documentation MDX files, ensure any `lastReviewed` dates are set using the repository project timezone `Asia/Bangkok`, not the reviewer’s local timezone or the runtime/build timezone. When generating or updating API-reference pages, intentionally use the exact same `lastReviewed` date convention as the authored public documentation pages to keep timestamps consistent across both sources.

Applied to files:

  • apps/docs/content/docs/architecture-security/evaluation/traceability.mdx
  • apps/docs/content/docs/getting-started/quickstart.mdx
  • apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx
  • apps/docs/content/docs/reference/api-reference/authentication.mdx
  • apps/docs/content/docs/getting-started/core-concepts.mdx
  • apps/docs/content/docs/architecture-security/asset-lifecycle.mdx
  • apps/docs/content/docs/reference/api-reference/platform.mdx
  • apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx
  • apps/docs/content/docs/reference/api-reference/assistant.mdx
  • apps/docs/content/docs/reference/api-reference/assets.mdx
  • apps/docs/content/docs/reference/api-reference/administration.mdx
  • apps/docs/content/docs/reference/api-reference/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/search-catalog.mdx
  • apps/docs/content/docs/guides/administration/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/index.mdx
  • apps/docs/content/docs/guides/administration/identity-permissions.mdx
  • apps/docs/content/docs/getting-started/index.mdx
  • apps/docs/content/docs/guides/integrations/assistant-mcp.mdx
📚 Learning: 2026-07-28T20:06:15.064Z
Learnt from: kl3inIT
Repo: kl3inIT/OrgMemory PR: 112
File: apps/docs/content/docs/developers/api-reference/authentication.mdx:12-12
Timestamp: 2026-07-28T20:06:15.064Z
Learning: In OrgMemory docs/tests that describe date-based review checks, treat the project timezone as Asia/Bangkok for all “date” comparisons/validations. Do not assume UTC when interpreting or validating fields like `lastReviewed`. For example, `lastReviewed: '2026-07-29'` should be considered valid when the effective “current date” in Asia/Bangkok is July 29, 2026 (not merely when the UTC date matches).

Applied to files:

  • apps/docs/content/docs/architecture-security/evaluation/traceability.mdx
  • apps/docs/content/docs/getting-started/quickstart.mdx
  • apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx
  • apps/docs/content/docs/reference/api-reference/authentication.mdx
  • apps/docs/content/docs/getting-started/core-concepts.mdx
  • apps/docs/content/docs/architecture-security/asset-lifecycle.mdx
  • apps/docs/content/docs/reference/api-reference/platform.mdx
  • apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx
  • apps/docs/content/docs/reference/api-reference/assistant.mdx
  • apps/docs/content/docs/reference/api-reference/assets.mdx
  • apps/docs/content/docs/reference/api-reference/administration.mdx
  • apps/docs/content/docs/reference/api-reference/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/search-catalog.mdx
  • apps/docs/content/docs/guides/administration/sources-connections.mdx
  • apps/docs/content/docs/reference/api-reference/index.mdx
  • apps/docs/content/docs/guides/administration/identity-permissions.mdx
  • apps/docs/content/docs/getting-started/index.mdx
  • apps/docs/content/docs/guides/integrations/assistant-mcp.mdx
📚 Learning: 2026-07-28T20:06:14.375Z
Learnt from: kl3inIT
Repo: kl3inIT/OrgMemory PR: 112
File: apps/docs/scripts/generate-openapi.ts:211-219
Timestamp: 2026-07-28T20:06:14.375Z
Learning: When generating OrgMemory documentation and authored documentation metadata (e.g., `lastReviewed`), evaluate and format any generated/derived dates using the project timezone `Asia/Bangkok`. Ensure the generated dates stay consistent with the authored corpus when interpreted in that timezone (i.e., avoid UTC/local-time defaults or timezone drift during OpenAPI/docs generation).

Applied to files:

  • apps/docs/scripts/generate-openapi.ts
🪛 LanguageTool
apps/docs/AUTHORING.md

[style] ~15-~15: This phrase is redundant. Consider writing “follows”.
Context: ...lishes the approved meaning. Vietnamese follows after English review and preserves that mea...

(FOLLOW_AFTER)

apps/docs/content/docs/guides/administration/identity-permissions.mdx

[style] ~77-~77: Using a “neither–nor” construction here can make your writing sound more fluent.
Context: ...is business/classification state. It is not a Keycloak role and not an OpenFGA relationship. Changing it cannot grant organization ...

(N_NOR)

🔇 Additional comments (48)
apps/docs/ARCHITECTURE.md (1)

6-8: LGTM!

Also applies to: 36-39

apps/docs/AUTHORING.md (1)

1-21: LGTM!

Also applies to: 23-37, 46-48, 50-107, 109-164

apps/docs/CLAUDE.md (1)

4-5: LGTM!

Also applies to: 19-21

apps/docs/README.md (1)

16-24: LGTM!

package.json (1)

14-15: LGTM!

apps/docs/content/docs/reference/api-reference/administration.mdx (1)

1-172: LGTM!

apps/docs/content/docs/reference/api-reference/assets.mdx (1)

1-229: LGTM!

apps/docs/content/docs/reference/api-reference/assistant.mdx (1)

1-115: LGTM!

apps/docs/content/docs/reference/api-reference/authentication.mdx (1)

1-48: LGTM!

apps/docs/content/docs/reference/api-reference/index.mdx (1)

21-34: LGTM!

apps/docs/content/docs/reference/api-reference/knowledge-graph.mdx (1)

1-68: LGTM!

apps/docs/content/docs/reference/api-reference/meta.json (1)

1-16: LGTM!

apps/docs/generated-api.manifest.json (1)

5-55: LGTM!

apps/docs/scripts/generate-openapi.ts (1)

15-15: 📐 Maintainability & Code Quality

Run the required docs verification before merge.

Attach lint, typecheck, tests, production build, and browser-route verification results, along with:

pnpm --filter orgmemory/docs check
pnpm --filter orgmemory/docs build

As per coding guidelines, “Frontend verification must include lint, typecheck, tests, production build, and browser verification when the flow matters.” Based on learnings, run pnpm --filter orgmemory/docs check and pnpm --filter orgmemory/docs build.

Also applies to: 176-178, 245-245

apps/docs/next.config.mjs (1)

6-37: LGTM!

Also applies to: 44-57

apps/docs/public-content.manifest.json (1)

5-79: LGTM!

apps/docs/src/app/[lang]/docs/[[...slug]]/page.tsx (1)

94-94: LGTM!

apps/docs/src/app/global.css (1)

15-42: LGTM!

apps/docs/src/lib/docs-category.ts (1)

2-5: LGTM!

Also applies to: 16-16

apps/docs/src/lib/i18n.ts (1)

23-23: LGTM!

apps/docs/test/e2e/navigation.spec.ts (1)

18-18: 📐 Maintainability & Code Quality

Confirm required frontend verification.

Attach results for lint, typecheck, tests, production build, browser verification, pnpm --filter orgmemory/docs check, and pnpm --filter orgmemory/docs build before handoff. As per coding guidelines, frontend changes require those verification stages; retrieved learnings require the docs check and build before handoff.

Also applies to: 42-47, 58-61, 88-88, 104-116, 118-155, 182-183, 204-204, 231-231

Sources: Coding guidelines, Learnings

apps/docs/content/docs/meta.json (1)

4-7: LGTM!

apps/docs/content/docs/meta.vi.json (1)

4-7: LGTM!

apps/docs/content/docs/getting-started/meta.json (1)

1-11: LGTM!

apps/docs/content/docs/getting-started/meta.vi.json (1)

1-11: LGTM!

apps/docs/content/docs/reference/meta.vi.json (1)

1-10: LGTM!

apps/docs/content/docs/guides/administration/identity-permissions.mdx (1)

1-130: LGTM!

apps/docs/content/docs/guides/administration/meta.json (1)

2-2: LGTM!

apps/docs/content/docs/guides/administration/meta.vi.json (1)

2-2: LGTM!

apps/docs/content/docs/guides/administration/sources-connections.mdx (1)

1-104: LGTM!

apps/docs/content/docs/getting-started/core-concepts.mdx (1)

1-101: LGTM!

apps/docs/content/docs/getting-started/quickstart.mdx (1)

99-100: LGTM!

apps/docs/content/docs/getting-started/index.mdx (1)

74-79: LGTM!

apps/docs/content/docs/architecture-security/meta.json (1)

2-8: LGTM!

apps/docs/content/docs/guides/integrations/assistant-mcp.mdx (1)

1-121: LGTM!

apps/docs/content/docs/reference/api-reference/platform.mdx (1)

1-68: LGTM!

apps/docs/content/docs/reference/api-reference/search-catalog.mdx (1)

1-47: LGTM!

apps/docs/content/docs/reference/api-reference/sources-connections.mdx (1)

1-158: LGTM!

apps/docs/content/docs/architecture-security/asset-lifecycle.mdx (2)

1-12: 🗄️ Data Integrity & Integration

Verify public-content manifest registration.

Confirm this new page is listed in apps/docs/public-content.manifest.json and that sourceRefs remains build-time metadata rather than rendered page content.

Source: Coding guidelines


15-79: LGTM!

apps/docs/content/docs/architecture-security/evaluation/traceability.mdx (1)

61-61: LGTM!

apps/docs/content/docs/guides/meta.json (1)

1-12: LGTM!

apps/docs/content/docs/guides/meta.vi.json (1)

1-12: LGTM!

apps/docs/content/docs/guides/deployment-operations/meta.json (1)

2-7: LGTM!

apps/docs/content/docs/guides/deployment-operations/self-hosting.mdx (1)

49-49: LGTM!

apps/docs/content/docs/guides/integrations/meta.json (1)

1-8: LGTM!

apps/docs/content/docs/guides/integrations/meta.vi.json (1)

1-8: LGTM!

apps/docs/content/docs/reference/meta.json (1)

1-10: LGTM!

Comment on lines 7 to +8
"system-description",
"asset-lifecycle",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Do not publish this entry in Vietnamese navigation yet.

The supplied cohort contains only the English Asset Lifecycle page. Remove asset-lifecycle from meta.vi.json until its reviewed Vietnamese translation is added.

As per coding guidelines, Vietnamese translations must be added one reviewed page at a time and must not be machine-published untranslated.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/docs/content/docs/architecture-security/meta.vi.json` around lines 7 -
8, Remove the "asset-lifecycle" entry from the Vietnamese navigation list in
meta.vi.json, leaving "system-description" and the remaining entries unchanged
until a reviewed Vietnamese translation is available.

Source: Coding guidelines

Comment thread apps/docs/README.md
@kl3inIT
kl3inIT merged commit e2a3763 into main Jul 29, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant