Skip to content
OKForestOKForestOKForest

Browser

OKForest’s browser shows people the same trees that AI assistants read over MCP: every concept rendered from its markdown, with its status, trust tier, and links, and its diagrams drawn from their source.

How it works

Section titled “How it works”
OKForest reads your Git repository through a read-only GitHub App, parses the tree per commit, and shows it to you as browser pages.
  • You sign in to see anything. Each account’s trees are visible only to the people given access to it.
  • Your content stays in your repository. OKForest reads it through the same read-only GitHub App as the MCP server, and shows the latest commit of the tree’s branch. People need no GitHub account to read it.

Addresses

Section titled “Addresses”

Every page belongs to an account, so a link means the same thing to everyone who can open it:

Address What it shows
/@/<account>/ The account’s trees
/@/<account>/<tree>/ A tree’s top directory
/@/<account>/<tree>/<directory>/ A directory: its index.md, or a listing of its concepts
/@/<account>/<tree>/<concept id> A concept, by its path without .md (policies/refunds)
/@/<account>/-/search?q=… Search across the account’s trees
/@/<account>/<tree>/-/freshness The tree’s freshness report

Accounts are identified by a random ID, and trees by a short name the account chooses; a tree’s former names redirect to its current one. Anything you can’t read looks exactly like something that doesn’t exist.

Pages

Section titled “Pages”
  • Concepts show their body, their status and trust tier as badges, their type, tags, and provenance, the concepts they link to and the concepts that link to them, and a link to the file in the repository.
  • Directories show their index.md, or a listing of their concepts and subdirectories.
  • Search finds concepts matching every keyword, ranked as the MCP search_concepts tool ranks them, and filters by tree, type, tag, status, and trust tier.
  • The freshness report lists the concepts that need attention: stale, draft, unverified, and deprecated.

Markdown

Section titled “Markdown”

Concepts are GitHub-flavored markdown: tables, task lists, and footnotes work. Raw HTML is dropped, so a concept can’t add scripts or styles to the page.

  • Links between concepts become browser links. A link to something the tree doesn’t have is marked as broken.
  • Images in the tree are shown, up to 2 MB each and 16 MB per tree. Larger images, and other files such as PDFs, link to the file in the repository.
  • Images and diagrams zoom when you click them: fitted to the window, or at actual size to pan around.
  • Code blocks are highlighted when they name a language (```sql, ```python): Bash, CSS, diff, Dockerfile, Go, INI and TOML, Java, JavaScript, JSON, Markdown, Python, Rust, SQL, TypeScript, XML and HTML, and YAML. Other code blocks stay plain.

Diagrams

Section titled “Diagrams”

Diagrams are code blocks in the concept (diagrams as code), shown as a drawing with the source underneath. Each is drawn in a light and a dark version, which follow the browser’s theme. A diagram that can’t be drawn shows its source, with the reason above it.

D2

Section titled “D2”
```d2
customer -> support: asks for a refund
support -> billing: approves
```

OKForest draws D2 diagrams on its servers and keeps them, so a diagram is drawn once, not on every view; a new one can take a few seconds the first time.

  • Layouts: dagre (D2’s default) and ELK (vars: { d2-config: { layout-engine: elk } }). TALA isn’t available, and a diagram can’t import other files.
  • Themes: the light version uses the diagram’s theme; the dark version uses its dark theme, or D2’s Dark Mauve.
  • Limits: 100 KB of source, 500 shapes, and 1,000 connections. Split anything larger into several diagrams.
  • Icons and images (icon: …) can be files in the tree, by a path relative to the concept, or https images from hosts the account allows. No hosts are allowed unless you ask; for now, email support@okforest.ai to add one. Other images are left out of the drawing.

Mermaid

Section titled “Mermaid”
```mermaid
sequenceDiagram
    Customer->>Support: Asks for a refund
    Support-->>Customer: Approved
```

Mermaid diagrams are drawn in your web browser, in a sandbox that can’t reach the page or the network. Labels are plain text, and links and click handlers in a diagram are ignored. A diagram is drawn when the page is showing, so one opened in a background tab is drawn when you switch to it.

The okforest/d2-syntax and okforest/mermaid-syntax rules check that diagrams parse, in the CLI and the GitHub Action, so a broken diagram is caught before it’s merged.

Security

Section titled “Security”
  • Read only. The browser reads trees through a GitHub App with read-only access to the repositories you choose; nothing in it changes your content.
  • Content can’t run anything. Raw HTML in markdown is dropped, and pages allow only OKForest’s own scripts. Diagrams are shown as images, which can’t run scripts or load anything; Mermaid runs in a sandbox, never in the page.