Skip to content

docs: replace ASCII architecture diagram with a rendered image#143

Closed
KylinMountain wants to merge 1 commit into
mainfrom
docs/architecture-diagram
Closed

docs: replace ASCII architecture diagram with a rendered image#143
KylinMountain wants to merge 1 commit into
mainfrom
docs/architecture-diagram

Conversation

@KylinMountain

Copy link
Copy Markdown
Collaborator

What

Replaces the ASCII architecture diagram under How OpenKB Works → Architecture with a rendered illustration (assets/openkb-architecture.png).

Why

The rendered diagram conveys the same pipeline much more clearly than ASCII art, while staying faithful to the actual flow.

Details

  • New image lives in a new top-level assets/ dir — docs/ is gitignored, so README assets can't live there.
  • Referenced via a centered relative-path <img>, matching the README's existing centered-image style.
  • The diagram matches the documented pipeline and the code: dual ingest (markitdown for short docs / PageIndex for long PDFs) → LLM wiki compilation → the wiki/ foundation (index.md, log.md, AGENTS.md, sources/, summaries/, concepts/, entities/, explorations/, reports/) → query/chat, the Skill Factory, and future generators.

Notes

  • Image is ~1.7MB; happy to compress to WebP / lower-res (~200–400KB) if preferred.

Swap the text-based diagram under "Architecture" for a rendered
illustration (assets/openkb-architecture.png) covering the same pipeline:
raw/ intake -> markitdown (short docs) / PageIndex (long PDFs) -> LLM
wiki compilation -> the wiki/ foundation -> query/chat, the Skill
Factory, and future generators.
@KylinMountain

Copy link
Copy Markdown
Collaborator Author

Superseded by #144 — folding the architecture diagram into the OpenRouter docs branch so both changes ship in one PR.

@KylinMountain KylinMountain deleted the docs/architecture-diagram branch June 26, 2026 12:13
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