Skip to content

docs(okf): integrate OKF v0.1 architectural knowledge base and tycho package - #29

Closed
crapougnax wants to merge 15 commits into
developfrom
fix/docs-pipeline-build
Closed

crapougnax wants to merge 15 commits into
developfrom
fix/docs-pipeline-build

Conversation

@crapougnax

Copy link
Copy Markdown
Collaborator

Summary

This PR integrates an official Open Knowledge Format (OKF v0.1) architectural knowledge base directly into Quatrain/Core and packages it as a native Tycho Knowledge Package (tycho knowledge).

Key Additions

  1. OKF Knowledge Base (okf/):

    • 8 foundational architecture fiches with progressive disclosure routers (okf/index.md, domain-modeling/, persistence-adapters/, auth-and-security/, storage-and-assets/, queues-and-events/, api-and-gateways/, ai-and-agents/).
    • Every code example has been audited and verified against the actual package implementations (BaseObject, PersistedBaseObject, BaseRepository, Backend.addBackend, Storage.addStorage, Queue.addQueue, Auth.addProvider, WorkflowStateMachine, RbacPolicyEngine, ApiClient, CrudEndpoint, GeminiAdapter).
    • Strict TypeScript without as any assertions.
  2. Tycho Knowledge Package (.tycho/):

    • .tycho/repository.json and .tycho/knowledge/quatrain-core/package.json declaring the package metadata.
    • .tycho/knowledge/quatrain-core/post-install.sh hook to automatically link the okf/ tree into local AI agent knowledge bases (such as AGENTS.okf) and refresh LLM routers.
  3. Documentation Site Pipeline Integration:

    • Updated scripts/build-docs.ts with aggregateOkfFiles() to dynamically copy the fiches into docs/pages/okf/ and auto-generate Nextra _meta.js navigation files from YAML frontmatter.
    • Added okf tab to docs/pages/_meta.js.
    • Updated .gitignore to track all Nextra _meta.js navigation files.
  4. Root README Promotion:

    • Added dedicated section highlighting the OKF knowledge base and the 3-step Tycho installation workflow (tycho repo add, tycho knowledge install, tycho knowledge list).

@codacy-production

codacy-production Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 9 critical · 18 high · 12 medium · 61 minor

Alerts:
⚠ 100 issues (≤ 0 issues of at least minor severity)

Results:
100 new issues

Category Results
BestPractice 8 minor
Security 2 minor
18 high
9 critical
12 medium
CodeStyle 51 minor

View in Codacy

🟢 Metrics 8 complexity · 0 duplication

Metric Results
Complexity 8
Duplication 0

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@crapougnax

Copy link
Copy Markdown
Collaborator Author

Superseded by modular @quatrain/okf-ingest package (PR #66) and decoupled AGENTS.okf authority repository.

@crapougnax crapougnax closed this Oct 12, 2026
@crapougnax
crapougnax deleted the fix/docs-pipeline-build branch October 12, 2026 08:59
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