diff --git a/.gitea/workflows/docs-check.yml b/.gitea/workflows/docs-check.yml new file mode 100644 index 0000000..17dc263 --- /dev/null +++ b/.gitea/workflows/docs-check.yml @@ -0,0 +1,26 @@ +name: Docs Check +on: + push: + paths: + - '**.md' + - 'docs/**' + pull_request: + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Markdown lint + run: | + npm install -g markdownlint-cli + markdownlint '**/*.md' --ignore node_modules + - name: Link check + run: | + npm install -g markdown-link-check + find . -name '*.md' -not -path '*/node_modules/*' \ + -exec markdown-link-check {} \; + - name: Spell check + run: | + pip install codespell + codespell '**/*.md' --skip='*.git*' diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b3a876..288e28b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# Changelog - Apex Track Experience +# Apex Track Experience — CHANGELOG -### 2026-07-10 -- **Setup:** Initial project directory structure created. +## 2026-07-10 — Initial +- Created project repository and directory structure. diff --git a/README.md b/README.md index 814df10..d0e6d54 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ -# apex-track +# Apex Track Experience -Project directory. See CHANGELOG.md for development history. +> **Owner:** Germaine | **Status:** PLANNED +> **Last Updated:** 2026-08-09 + +Apex Track is a track event and racing experience management platform. Designed for track day organizers, racing clubs, and motorsport venues to manage event scheduling, participant registration, timing and scoring, and live results publishing. + +## Tech Stack + +- TBD — architecture and stack decisions pending + +## Quick Start + +```bash +git clone https://git.itpropartner.com/ippadmin/apex-track.git +cd apex-track +# Project in early planning phase — implementation to follow +``` + +## Related + +- [itpp-infrastructure](https://git.itpropartner.com/ippadmin/itpp-infrastructure) — server inventory, DNS +- [itpp-standards](https://git.itpropartner.com/ippadmin/itpp-standards) — docs standards and templates