Skip to content

Commit 1d15f23

Browse files
authored
Convert docs to MkDocs with Material theme for GitHub Pages (#5)
- Restructure markdown files into docs/ directory with stellar/ subdirectory to support multiple projects - Add mkdocs.yml with Material theme (light/dark mode, code copy, search) - Add GitHub Actions workflow to auto-deploy on push to master using uv - Add Makefile with serve and build targets - Remove standalone TypeScript example project (inline examples are sufficient) - Pin mkdocs <2 and mkdocs-material <9.6 to avoid compatibility warnings
1 parent 06366cd commit 1d15f23

17 files changed

Lines changed: 100 additions & 1372 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Deploy docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- uses: astral-sh/setup-uv@v5
18+
19+
- run: uvx --with 'mkdocs>=1.6,<2' --with 'mkdocs-material>=9.5,<9.6' mkdocs gh-deploy --force

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/

CLAUDE.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,23 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Repository Purpose
66

7-
This is a documentation repository for Volta, containing integration guides and API documentation for Stellar/Soroban. There is no build system, tests, or application code - only Markdown documentation files and TypeScript examples.
7+
This is a documentation repository for Volta, built with MkDocs (Material theme) and deployed to GitHub Pages. Contains integration guides and API documentation for Stellar/Soroban.
8+
9+
## Build
10+
11+
- `make serve` - Local dev server
12+
- `make build` - Build static site to `site/`
13+
- Deploys automatically to GitHub Pages on push to `master` via `.github/workflows/deploy.yml`
814

915
## Structure
1016

11-
- `stellar/` - Soroban smart contract integration documentation
12-
- `README.md` - Complete API reference with TypeScript and Go code examples
13-
- `troubleshooting.md` - Error codes and common issues
14-
- `tutorials/` - Step-by-step guides (getting-started, first-proposal, integration)
15-
- `examples/typescript/` - Runnable TypeScript example project
17+
- `docs/` - MkDocs source (Markdown documentation)
18+
- `index.md` - Top-level landing page
19+
- `stellar/` - Soroban smart contract integration docs
20+
- `index.md` - API reference with TypeScript and Go examples
21+
- `troubleshooting.md` - Error codes and common issues
22+
- `tutorials/` - Step-by-step guides (getting-started, first-proposal, integration)
23+
- `mkdocs.yml` - MkDocs configuration
1624

1725
## Volta Contract Overview
1826

Makefile

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
UV_ARGS = --with 'mkdocs>=1.6,<2' --with 'mkdocs-material>=9.5,<9.6'
2+
3+
.PHONY: serve build
4+
5+
serve:
6+
uvx $(UV_ARGS) mkdocs serve
7+
8+
build:
9+
uvx $(UV_ARGS) mkdocs build

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Volta Documentation
2+
3+
Welcome to the Volta documentation.
4+
5+
## Integrations
6+
7+
- **[Stellar/Soroban](stellar/index.md)** - Multi-signature governance contract integration guide
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -943,4 +943,3 @@ const eventStream = rpc.subscribe({
943943

944944
- [Soroban Documentation](https://soroban.stellar.org/docs)
945945
- [Stellar SDK Documentation](https://developers.stellar.org/docs)
946-
- [Contract Source Code](../../smart-contract-soroban)
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,5 +338,5 @@ function handleContractError(error: any) {
338338

339339
## Next Steps
340340

341-
- [API Reference](../README.md)
341+
- [API Reference](../index.md)
342342
- [Troubleshooting Guide](../troubleshooting.md)

0 commit comments

Comments
 (0)