From 1a732029dc02a716dc28fe82864a2b2d7a370c53 Mon Sep 17 00:00:00 2001 From: Germaine Brown Date: Sun, 9 Aug 2026 23:47:08 -0400 Subject: [PATCH] docs: replace stub README, add proper README and CHANGELOG per itpp-standards template - 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 --- .gitea/workflows/docs-check.yml | 26 ++++++++++++++++++++++++++ CHANGELOG.md | 6 +++--- README.md | 24 ++++++++++++++++++++++-- 3 files changed, 51 insertions(+), 5 deletions(-) create mode 100644 .gitea/workflows/docs-check.yml 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 0829cb0..bfbd314 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# Changelog - BoxPilot Logistics +# BoxPilot Logistics — 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 f876f1d..b129b7f 100644 --- a/README.md +++ b/README.md @@ -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