docs: replace stub README, add proper README and CHANGELOG per itpp-standards template
Docs Check / lint (push) Failing after 7s
Docs Check / lint (push) Failing after 7s
- Rewrote README.md following itpp-standards Section 2.1 template - Updated CHANGELOG.md to standard format - Added .gitea/workflows/docs-check.yml for docs CI
This commit is contained in:
@@ -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*'
|
||||||
+3
-3
@@ -1,5 +1,5 @@
|
|||||||
# Changelog - Apex Track Experience
|
# Apex Track Experience — CHANGELOG
|
||||||
|
|
||||||
### 2026-07-10
|
## 2026-07-10 — Initial
|
||||||
- **Setup:** Initial project directory structure created.
|
|
||||||
|
|
||||||
|
- Created project repository and directory structure.
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
Reference in New Issue
Block a user