Skip to content

CodeVelo documentation

Discover. Deliver. Operate.

This repository contains public documentation for CodeVelo's services, platform direction, engineering approach, and selected product concepts.

CodeVelo is a West Virginia engineering partner for web platforms, managed hosting, commercial networks, structured cabling, and conference room AV. We connect software, infrastructure, deployment, and ongoing operations under one accountable technical partner.

Documentation

Scope

These documents explain CodeVelo at a public, product-oriented level. They intentionally exclude production topology, privileged configuration, client information, credentials, private operating procedures, and proprietary implementation details.

Product names and architectural roles describe the current CodeVelo platform direction. They do not guarantee that every component is publicly available, separately licensed, or offered as a standalone service.

This repository is provided under the CodeVelo Proprietary Documentation License. Publication on GitHub does not grant permission to copy, modify, or redistribute its materials except as expressly stated in that license.

Contact

For suspected vulnerabilities, follow the security policy rather than opening a public issue.

Local preview

The documentation site is built with MkDocs and the Material theme. With Python 3 installed:

python -m venv .venv
.venv\Scripts\activate
python -m pip install --requirement requirements.txt
mkdocs serve

On macOS or Linux, activate the environment with source .venv/bin/activate. Open http://127.0.0.1:8000 to preview the site. Run mkdocs build --strict before submitting a change.

Pushes to main are automatically built and deployed to GitHub Pages. Pull requests run the same strict build without deploying.