Skip to content

civic-interconnect/site

Repository files navigation

Site: Civic Interconnect

License: Apache-2.0 Deploy Docs Dependabot

Documentation site for Civic Interconnect. This repository is docs-only and does not publish a Python package.

Install

  • uv
  • VS Code (recommended)

One-Time Setup

Create a local environment and install dependencies.

uv self update
uv python pin 3.12
uv venv

# Windows:
.venv\Scripts\activate

# macOS/Linux:
# source .venv/bin/activate

uv sync --extra dev --extra docs --upgrade
uvx pre-commit install

Local Checks (Pre-commit)

git add .
uvx pre-commit autoupdate
uvx pre-commit run --all-files

Build and Serve Docs

uv run mkdocs build --strict
uv run mkdocs serve

Annotations

Annotations.md

License

MIT

About

Documentation site for Civic Interconnect.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Languages