DocMyRepos documentation

DocMyRepos syncs the docs/ folders of your GitHub repositories into Postgres and serves them as a searchable portal. This folder documents DocMyRepos itself. It is an Open Knowledge Format (OKF v0.2) bundle, so when DocMyRepos is pointed at its own repository you get an OKF space with type filters. The repository's README has the product overview and the quickstart.

Where to start

• New to the project: Getting started, then Configuration.
• Installing with one command: Install with the script.
• Writing OKF documents with an AI agent: Writing OKF documents with an agent, and the validation codes.
• Registering the GitHub App: GitHub App setup.
• How it works: Architecture, beginning with the system overview.
• Discussing a document on its page: Comments.
• Getting answers from the docs in plain language: Ask the docs.
• Looking something up: Reference (HTTP API, frontmatter, operations).
• Why it is built this way: Decisions.

Contents

Folder	What it holds
Architecture	System overview, sync engine, data model and security model.
Guides	Getting started, install script, comments, ask, configuration, webhooks, search, OKF.
Reference	The HTTP API, the frontmatter keys and the operations runbook.
Decisions	Short records of the choices that shape the design.

Recent changes are listed in the change log.

Concept types used in this bundle

OKF types are free-form strings. This bundle keeps to five, so the type filter stays short.

type	Used for
Concept	An explanation of how a part of the system works.
Guide	Steps to get something done.
Reference	Exact facts to look up: endpoints, keys, limits.
Runbook	What to check and do when operating an instance.
Decision	A design decision with its context and consequences.

index.md and log.md are reserved files in OKF. They are not concepts and carry no type.