This repository is the GitHub Pages documentation portal for serving LLMWiki-style Markdown folders as agent-readable Knowledge Sources:
llmwiki-serve: read-only Knowledge Source server for one Markdown/wiki folder.llmwiki-agent-bridge: optional runtime companion that gathers source evidence and returns one cited answer artifact.llmwiki-chat: optional browser workbench for source setup, bridge selection, graph/citation review, and run details.llmwiki-docs: cross-repo onboarding, architecture, protocol posture, release status, and operations references.
Use this repo for topics that cross repository boundaries. Keep repo-specific implementation details in the owning repo README or docs directory.
- Overview
- Demo
- Quickstart
- Data Flow
- Architecture
- Runtime Adapters
- Network & Security
- Release Status & Compatibility
The docs are intentionally local-first. Source checkouts are the supported first-run path until the first PyPI/npm package publication gates pass.
Shortest local path:
- Run
llmwiki-serveagainst your existing wiki folder, or use the bundled./examples/sample-wikisource. - Query
http://127.0.0.1:8765/query. - Add
llmwiki-agent-bridgeandllmwiki-chatonly when you need a companion bridge endpoint or browser workbench.
npm ci
npm run devnpm run checknpm run check verifies third-party license output and builds the VitePress
site from docs/.
| Path | Purpose |
|---|---|
docs/ |
VitePress pages and public assets. |
docs/.vitepress/ |
Site config and theme customizations. |
scripts/ |
Public-preview, Pages, organization-transfer, branch-policy, and license helper scripts. |
.github/workflows/ |
Preflight, Pages, CodeQL, and dependency-review workflows. |
CONTRIBUTING.md, SECURITY.md, SUPPORT.md |
Community and project policy docs. |
This portal is:
- a first-10-minute path across
serve, optionalagent-bridge, and optionalchat - a protocol and runtime role map
- a network/security posture guide
- a release-status, deployment, and troubleshooting reference for operators
It is not:
- a runtime package published to npm
- an official upstream LLM Wiki specification
- a certified MCP, A2A, or vendor-runtime conformance claim
- a replacement for each repository's README, changelog, or release checklist
Repository metadata and Pages paths target
knowledge-bridge-labs/llmwiki-docs. The hosted Pages site is the canonical
public-preview docs entrypoint once repository visibility and Pages deployment
are enabled.
| Area | Pages |
|---|---|
| Start | docs/index.md, docs/demo.md, docs/quickstart.md, docs/examples.md |
| Understand | docs/core-concepts.md, docs/data-flow.md, docs/architecture.md, docs/positioning.md |
| Connect | docs/runtime-adapters.md, docs/direct-agent-integrations.md, docs/ai-tools.md |
| Reference | docs/knowledge-source-format.md, docs/protocols.md, docs/api-reference.md, docs/cli-reference.md |
| Operate | docs/network-security.md, docs/deployment.md, docs/troubleshooting.md, docs/faq.md |
| Status | docs/status.md, docs/faq.md |
This is independent community documentation for LLM Wiki-style Markdown knowledge folders and agent-readable context. It is not an official project from Andrej Karpathy or any upstream producer named in compatibility examples.