docs-wiki

Expert knowledge for maintaining docs/ as an OKF-style LLM wiki. Frontmatter, page types, naming, cross-referencing, index format, log format, and category conventions. Triggers: wiki maintenance, doc

SKILL.md

GitHub

Docs Wiki Skill

Maintain docs/ as an incrementally-built, OKF-style, LLM-maintained wiki of interlinked markdown concept pages.

When to Apply

  • Wiki maintenance tasks (/wiki-ingest, /wiki-lint, /wiki-query)
  • Docs updates after code changes
  • Documentation audits and health checks
  • Answering questions from the wiki

Wiki Structure

File Role
docs/README.md Index — content catalog, grouped by category, links + one-line descriptions
docs/log.md Activity log — reverse-chronological record of all wiki operations
Category subdirectories One per page type (see table below)

OKF Frontmatter Contract

Every docs/**/*.md page is an OKF-style concept and must start with YAML frontmatter, followed by a blank line and the Markdown H1.

Required fields:

Field Rule
type Concept class such as Index, Guide, Architecture, Implemented Feature, Planned Feature, Report, Technical Reference, Backlog, or Log.
title Human-readable title; normally matches the H1.
description One concise sentence that can be shown in search results or agent routing.
resource Repository-relative path to the Markdown file; update it when moving/renaming pages.
tags Inline list containing gallery-docs plus useful folder/topic tags.
timestamp UTC ISO-8601 timestamp refreshed when metadata, meaning, or structure changes materially.
okf_version Recommended: 0.1 per backend OKF_ADOPTION.md.

When creating or moving pages, update frontmatter before index/log work. When only fixing links or typos, refresh timestamp only if the page meaning or metadata changed.

Automated lint

From sibling image-scoring-pipeline clone:

python scripts/okf_lint.py ../image-scoring-gallery/docs --profile vexlum --bundle-name docs

Page Types

Category Purpose Naming Example
architecture/ System design, overviews NN-topic.md 01-system-overview.md
features/implemented/ Shipped features NN-feature.md 01-nef-raw-fallback.md
features/planned/ Future work specs NN-feature.md or subdirs embeddings/00-summary.md
reports/ Point-in-time audits NN-topic-YYYY-MM.md 01-code-design-review-2026-03.md
planning/ Roadmaps, migrations NN-topic.md 02-firebird-postgresql-migration.md
guides/ How-to docs NN-topic.md 01-lint-recommendations.md
technical/ Reference docs UPPER_CASE.md PIPELINE_TERMINOLOGY.md
project/ Governance, backlog NN-topic.md 00-backlog-workflow.md
integration/ API/backend integration descriptive TODO.md

Index Format (docs/README.md)

Follow the existing format exactly:

  • Grouped by category with --- horizontal rule separators
  • Each category has an ## H2 heading
  • Entries: - [Display Title](relative/path.md) - One-line description
  • Numbered or alphabetical ordering within each category
  • Navigation footer at bottom: [Top](#) | [Section](#section) | ...

Log Format (docs/log.md)

  • Reverse-chronological (newest first)
  • Entries grouped under month headers: ## YYYY-MM
  • Entry format: - YYYY-MM-DD: <verb> — <details, pages affected>
  • Verbs: ingested, created, updated, lint-fixed, filed-back, reorganized

Cross-Referencing Rules

  1. Bidirectional — When A links to B, B should link back to A (where meaningful).
  2. Relative paths — From the referencing file, e.g., ../architecture/02-database-design.md.
  3. Anchors — Use section anchors for long pages: file.md#section-name.
  4. Backend cross-repo — Full GitHub URLs: https://github.com/synthet/image-scoring-pipeline/blob/main/docs/....
  5. Local stubs — When a canonical doc lives in the backend repo, the gallery stub notes where the canonical content is and links to it.

Page Conventions

  • Start with OKF YAML frontmatter, then # Title.
  • First paragraph is a one-sentence summary.
  • Standard markdown links only — no [[wikilinks]].
  • Kebab-case filenames, numbered prefixes for ordered sequences.

Validation Expectations

After structural docs work:

  • Run python scripts/okf_lint.py ../image-scoring-gallery/docs --profile vexlum from the sibling backend clone.
  • Every docs/**/*.md concept file has the required OKF fields (log.md exempt).
  • resource equals the repository-relative file path.
  • tags is an inline list and includes gallery-docs.
  • New or moved pages are represented in docs/README.md and, where applicable, local section indexes.

Relationship to SDLC Commands

After this... Consider this...
/implement produces code /wiki-ingest to capture the knowledge
Major release or milestone /wiki-lint to keep docs consistent
User asks a project question /wiki-query to answer from the wiki
/spec creates a feature spec /wiki-ingest to file it into the wiki
Code review surfaces decisions /wiki-ingest the decision as a report or architecture update