Skip to main content

AI-native enterprise documentation platform

Project description

gv-exp-specwright

AI-native enterprise documentation platform. Living specs that generate tickets, AI agents that maintain docs, repo-native knowledge that replaces Confluence.

Status

Stage: Brief Started: 2026-02-06 Timebox: 4 weeks (2 concierge + 2 prototype) Budget: $500

Hypothesis

We believe that engineering orgs (50-500 devs) will replace Confluence with a repo-native documentation platform because AI agents can keep docs alive automatically, and structured specs that generate tickets and track implementation progress are more valuable than static wiki pages.

Links

Quick Start

# Clone
git clone git@github.com:Gerner-Ventures/gv-exp-specwright.git
cd gv-exp-specwright

# Install all dependencies (backend + frontend)
make install

# Run tests
make test

# Run backend + frontend dev servers in parallel
make dev

Make Commands

Run make help for the full list. Highlights:

Command Description
make install Install backend + frontend dependencies
make dev Run FastAPI dev server with Doppler secrets on :3000
make test Run Python test suite
make lint Lint backend (ruff) + frontend (eslint)
make format Auto-fix and format Python code
make typecheck Run mypy + vue-tsc type checks
make build Build Vue SPA for production
make build-docker Build production Docker image
make docker-dev Run dev Docker image with source mounts
make helm-template Render Helm chart locally
make clean-all Remove all build artifacts + Docker images

Dev Environment (K8s)

Each developer gets an isolated environment on the shared DOKS cluster via DevSpace.

Prerequisites

One-time setup

doppler login
doctl auth init
doctl registry login                                      # DOCR auth
doctl kubernetes cluster kubeconfig save gv-shared        # kubeconfig

Daily workflow

export DEVSPACE_USERNAME=ng   # or set in .envrc

devspace dev                  # build, deploy, sync, port-forward
# → http://localhost:3000     (port-forwarded)
# → https://ng.specwright.gernerventures.com (ingress, after DNS setup)

devspace run logs             # tail pod logs
devspace run sync-secrets     # re-sync Doppler secrets
devspace run sync-trigger     # manually run reverse sync cron
devspace purge                # tear down dev environment

File changes in src/, templates/, and static/ sync into the pod and uvicorn auto-reloads.

See docs/self-hosting.md for production deployment and more details.

Architecture

Three-tier platform vision:

Tier What Status
Repo Agents Per-repo spec parsing, PR analysis, doc maintenance, ticket sync v0.1 target
Agent Mesh Cross-repo impact analysis, conflict detection, dependency mapping Future
Org Brain Cross-repo search, ownership graph, decision index, onboarding gen Future

Tech Stack

Component Technology
Backend Python 3.12+, FastAPI, uvicorn
Agent runtime Anthropic Python SDK (Claude)
Spec parser Custom markdown parser + python-frontmatter
Ticket sync Jira REST API / Linear GraphQL API / GitHub Issues
Web UI Vue 3, Vite, Tailwind CSS, Pinia
Hosting Self-hosted K8s (DigitalOcean) via Helm chart
Secrets Doppler
Dev tooling DevSpace

Project Structure

src/specwright/
  main.py              # FastAPI app: webhook routes, health checks
  settings.py          # Pydantic Settings (env vars)
  github/              # GitHub App webhook handling
  agent/               # Claude agent runtime
  parser/              # Spec markdown parser + writer
  sync/                # Ticket sync engine + adapters
  config/              # SPECWRIGHT.yaml parser
  cron/                # Reverse sync cron job
  web/                 # Web routes (serves Vue SPA + Jinja2 fallback)
  cli.py               # CLI entrypoint
  mcp/                 # MCP server
frontend/              # Vue 3 SPA (Vite + Tailwind + Pinia)
tests/                 # pytest tests
templates/             # Jinja2 HTML templates (fallback)
static/                # CSS/JS/images + built SPA (static/app/)
chart/specwright/      # Helm chart for K8s deployment

Current Metrics

Metric Target Current
PM spec adoption 60% -
Doc freshness 70% -
Engineer engagement 40% -
PM time saved 3 hrs/wk -
Question answer quality 70% -

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gv_specwright-1.1.0.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gv_specwright-1.1.0-py3-none-any.whl (219.4 kB view details)

Uploaded Python 3

File details

Details for the file gv_specwright-1.1.0.tar.gz.

File metadata

  • Download URL: gv_specwright-1.1.0.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gv_specwright-1.1.0.tar.gz
Algorithm Hash digest
SHA256 080f9e1ae885055c49d4b8227c2261e3232558477db798359471c3eb91eda023
MD5 aee631da7af121973b309b6a1315f236
BLAKE2b-256 0fc5fec4159422eca320b960c36faa2f3f8b0c1e742733ca311f9432483f6b2e

See more details on using hashes here.

Provenance

The following attestation bundles were made for gv_specwright-1.1.0.tar.gz:

Publisher: publish.yml on Gerner-Ventures/gv-exp-specwright

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gv_specwright-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: gv_specwright-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 219.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gv_specwright-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ceb5fecf0d71e73e2e31f3f70bcc47e841f502d7fcddee446eb567a5f8d8d7a9
MD5 700eb0befbd0e9e99aabf1760b0cbccc
BLAKE2b-256 0ad7c48c9024faf006a5d40d33dce338e99461a1b45ff7e30e05c3337457d105

See more details on using hashes here.

Provenance

The following attestation bundles were made for gv_specwright-1.1.0-py3-none-any.whl:

Publisher: publish.yml on Gerner-Ventures/gv-exp-specwright

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page