Skip to content

Add numbered architecture knowledge docs for OpenKore LLM KB - #2

Merged
boscv merged 4 commits into
codex/document-curation-plan-for-openkorefrom
codex/build-architecture-documentation-for-openkore
Mar 10, 2026
Merged

boscv merged 4 commits into
codex/document-curation-plan-for-openkorefrom
codex/build-architecture-documentation-for-openkore

Conversation

@boscv

@boscv boscv commented Mar 10, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Provide a concise, structured architecture knowledge layer so an LLM can reason about OpenKore internals, extension points, and high-level runtime flows.
  • Focus documentation on critical areas used by automation and analysis: AI, Actor system, Networking, Task system, Plugin/Macro systems, Configuration, and Routing.

Description

  • Added six new numbered knowledge files under openkore_llm_knowledge/knowledge/: 01_llm_context.md, 02_architecture_overview.md, 03_system_architecture_map.md, 04_core_subsystems.md, 05_module_dependency_map.md, and 20_code_index.md that together map structure, entry points, and module relationships.
  • Each file references concrete modules and directories (for example src/functions.pl, src/AI.pm, src/Actor.pm, src/Network.pm, src/TaskManager.pm, plugins/macro/*, control/*, tables/*, and fields/*) to ground explanations in repository layout.
  • Descriptions emphasize runtime flows (main loop -> receive -> actor -> AI -> tasks -> send), coupling hotspots (src/Globals.pm, src/Commands.pm, src/TaskManager.pm, src/Network/Receive.pm) and a recommended navigation order for code review and analysis.

Testing

  • Ran an automated path-validation script that extracts backticked module paths from the new docs and verifies referenced concrete paths exist, excluding wildcard/grouped notations; the adjusted validation run succeeded.
  • Performed a repository file scan to ensure the new openkore_llm_knowledge/knowledge/ files are present and readable by tooling, and no code or unit tests were modified.

Codex Task

@boscv
boscv merged commit 3afda82 into codex/document-curation-plan-for-openkore Mar 10, 2026
4 checks passed
@boscv
boscv deleted the codex/build-architecture-documentation-for-openkore branch March 11, 2026 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant