~ knotless Search/
↑↓ move↵ open⇧↵ all results

johnandersen777.bsky.social/socialweb-computer-console

console.socialweb.computer: kcp, kubectl and ssh compiled to wasm in a browser tab with a terminal; a kcp fork

0
0
main
48 lines · 2.6 KB Raw History

kcp Documentation Setup

Overview

Our documentation is powered by Material for MkDocs with some additional plugins and tools:

We have support in place for multiple languages (i18n), although we currently only have documentation in English. If you're interested in contributing translations, please let us know!

File structure

All documentation-related items live in docs (with the small exception of various make targets and some helper scripts in hack).

The structure of docs is as follows:

PathDescription
config/$language/mkdocs.ymlLanguage-specific mkdocs configuration.
content/$languageLanguage-specific website content.
generated/branchAll generated content for all languages for the current version.
generated/branch/$languageGenerated content for a single language. Never added to git.
generated/branch/index.htmlMinimal index for the current version that redirects to the default language (en)
overridesGlobal (not language-specific) content.
DockerfileBuilds the kcp-docs image containing mkdocs + associated tooling.
mkdocs.ymlMinimal mkdocs configuration for mike for multi-version support.
requirements.txtList of Python modules used to build the site.

Publishing Workflow

All documentation building and publishing is done using GitHub Actions in docs-gen-and-push.yaml. The overall sequence is:

  1. Generate CLI docs
  2. Generate API docs
  3. Run mkdocs build for all languages
  4. Run mike deploy --push

Theme Overrides

The goal is to have no full overrides of any theme partials. We currently override header.html to customize the way the language selection dropdown is rendered. We are working with the theme developers to see if we can help make some changes upstream that don't require an override.