docs: replace stub README, add proper README and CHANGELOG per itpp-standards template
Docs Check / lint (push) Failing after 6s

- 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:
Germaine Brown
2026-08-09 23:47:08 -04:00
parent 962aa49b9f
commit 1a732029dc
3 changed files with 51 additions and 5 deletions
+26
View File
@@ -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
View File
@@ -1,5 +1,5 @@
# Changelog - BoxPilot Logistics # BoxPilot Logistics — CHANGELOG
### 2026-07-10 ## 2026-07-10 — Initial
- **Setup:** Initial project directory structure created.
- Created project repository and directory structure.
+22 -2
View File
@@ -1,3 +1,23 @@
# boxpilot # BoxPilot Logistics
Project directory. See CHANGELOG.md for development history. > **Owner:** Germaine | **Status:** PLANNED
> **Last Updated:** 2026-08-09
BoxPilot is a logistics operations platform for freight, shipping, and delivery management. Designed to streamline dispatch, route optimization, carrier management, and shipment tracking for logistics operations.
## Tech Stack
- TBD — architecture and stack decisions pending
## Quick Start
```bash
git clone https://git.itpropartner.com/ippadmin/boxpilot.git
cd boxpilot
# 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