Skip to content

feat: docs scaffolding using mkdocs.yml#10

Merged
HackStrix merged 1 commit intomainfrom
sn/docs-app-scaffolding
Mar 20, 2026
Merged

feat: docs scaffolding using mkdocs.yml#10
HackStrix merged 1 commit intomainfrom
sn/docs-app-scaffolding

Conversation

@HackStrix
Copy link
Copy Markdown
Collaborator

This pull request introduces a comprehensive documentation site for the project using MkDocs with the Material theme. It adds a new documentation structure covering architecture, deployment, SDKs, and installation guides, and configures the site navigation, theme, and build requirements.

Documentation content:

  • Added new documentation markdown files for architecture (dual-mode.md, singleflight.md, tracking.md), Go library (install.md, pool.md, workers.md), daemon usage (install.md, cli.md, uds.md), SDKs (python.md, elixir.md), deployment (kubernetes.md, bare-metal.md), and introductory materials (index.md, quickstart.md). [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]

Documentation site configuration:

  • Added mkdocs.yml to define site metadata, navigation, theme options, markdown extensions, and structure for the new documentation site.
  • Added requirements-docs.txt specifying MkDocs and MkDocs Material as dependencies for building the documentation site.

@HackStrix HackStrix merged commit b0f375e into main Mar 20, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant