Repository navigation
docs(okf): integrate OKF v0.1 architectural knowledge base and tycho package - #29
Closed
crapougnax wants to merge 15 commits into
Closed
crapougnax wants to merge 15 commits into
crapougnax wants to merge 15 commits into
Conversation
… and pipeline triggers
…g, and ecosystem documentation
Not up to standards ⛔🔴 Issues
|
| Category | Results |
|---|---|
| BestPractice | 8 minor |
| Security | 2 minor 18 high 9 critical 12 medium |
| CodeStyle | 51 minor |
🟢 Metrics 8 complexity · 0 duplication
Metric Results Complexity 8 Duplication 0
AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.
TIP This summary will be updated as you push new changes.
…to AGENTS.okf doctrine
…r path-based routing
…ter, CoreHero and CoreFeatureCard components
…ackage link prefixes
…dd nginx safety redirect
…ernational English
…International English
… and enhance BaseRepository
…c ObjectUri deduction
Collaborator
Author
|
Superseded by modular @quatrain/okf-ingest package (PR #66) and decoupled AGENTS.okf authority repository. |
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
This PR integrates an official Open Knowledge Format (OKF v0.1) architectural knowledge base directly into
Quatrain/Coreand packages it as a native Tycho Knowledge Package (tycho knowledge).Key Additions
OKF Knowledge Base (
okf/):okf/index.md,domain-modeling/,persistence-adapters/,auth-and-security/,storage-and-assets/,queues-and-events/,api-and-gateways/,ai-and-agents/).BaseObject,PersistedBaseObject,BaseRepository,Backend.addBackend,Storage.addStorage,Queue.addQueue,Auth.addProvider,WorkflowStateMachine,RbacPolicyEngine,ApiClient,CrudEndpoint,GeminiAdapter).as anyassertions.Tycho Knowledge Package (
.tycho/):.tycho/repository.jsonand.tycho/knowledge/quatrain-core/package.jsondeclaring the package metadata..tycho/knowledge/quatrain-core/post-install.shhook to automatically link theokf/tree into local AI agent knowledge bases (such asAGENTS.okf) and refresh LLM routers.Documentation Site Pipeline Integration:
scripts/build-docs.tswithaggregateOkfFiles()to dynamically copy the fiches intodocs/pages/okf/and auto-generate Nextra_meta.jsnavigation files from YAML frontmatter.okftab todocs/pages/_meta.js..gitignoreto track all Nextra_meta.jsnavigation files.Root README Promotion:
tycho repo add,tycho knowledge install,tycho knowledge list).