From 24dc4c62c167dbc84de44f6db6b18369392775a2 Mon Sep 17 00:00:00 2001 From: Hardik Date: Sun, 21 Jun 2026 21:05:14 +0530 Subject: [PATCH] docs(wiki): link Crewing under Planned; drop staging README Repoint the Planned sidebar entry from the throwaway README staging file to the real Crewing-Module hub page, add a Crewing section to the Planned Features page, and delete README.md. --- Planned-Features.md | 12 ++++++++++++ README.md | 36 ------------------------------------ _Sidebar.md | 2 +- 3 files changed, 13 insertions(+), 37 deletions(-) delete mode 100644 README.md diff --git a/Planned-Features.md b/Planned-Features.md index a553312..97ce335 100644 --- a/Planned-Features.md +++ b/Planned-Features.md @@ -16,6 +16,18 @@ financial year, Top-N scope). proposed layout and navigation, with a link to the interactive `reports-mockup.html`. +## Crewing / Manning + +A post-MVP **Crewing Module** that extends PPMS from a purchasing system into a +crew lifecycle system — auto-raised requisitions on sign-off, a gated candidate +pipeline, onboarding, site HR (attendance, leave, PPE, documents), and a monthly +wage report for Accounts. It reuses the PO module's state-machine, permission-map, +audit-trail and file-storage patterns. + +→ **[Crewing Module](Crewing-Module)** — landing page with the full page map: +design document, architecture, data model, workflows, use cases, roles & +permissions, and user stories (Mermaid diagrams throughout). + --- *Add new planned features here as they are designed. When a planned feature diff --git a/README.md b/README.md deleted file mode 100644 index baa5e61..0000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# Crewing wiki bundle - -Design documentation for the **Crewing / Manning Module** of Pelagia Portal -(PPMS). Drop these pages into the Forgejo wiki repo root and push. - -## Pages - -| File | Wiki page | Contains | -|---|---|---| -| `Crewing-Module.md` | Crewing Module | Landing page / feature overview | -| `Crewing-Design-Document.md` | Crewing Design Document | Goals, scope, domain narrative, decisions, open questions | -| `Crewing-Architecture.md` | Crewing Architecture | System + **component diagram**, module layout | -| `Crewing-Data-Model.md` | Crewing Data Model | Enums, rank hierarchy, **ER diagram** | -| `Crewing-Workflows.md` | Crewing Workflows | **State machines** + **sequence diagrams** | -| `Crewing-Use-Cases.md` | Crewing Use Cases | **Use-case diagram** + catalogue | -| `Crewing-Roles-and-Permissions.md` | Crewing Roles and Permissions | Permission matrix extension | -| `Crewing-User-Stories.md` | Crewing User Stories | Backlog by epic with acceptance criteria | - -## Diagrams - -All diagrams are **Mermaid** fenced code blocks (` ```mermaid `), which Forgejo -renders natively — no screenshot pipeline needed (unlike the script-based -mockups). If a target renderer doesn't support Mermaid, the blocks degrade to -readable text. The `images/crewing/` folder is reserved for any future static -captures and currently empty. - -## Cross-links - -Pages link to each other and to existing wiki pages (`Architecture`, -`Data-Model`, `Roles-and-Permissions`, `PO-Lifecycle`, `File-Storage`, -`Inventory-and-Catalogue`) using Forgejo's `[Text](Page-Name)` wiki-link form. - -## Source - -Derived from the director meeting notes, two notebook pages (site-staff record -permissions; recruitment flow), and `Crewing.excalidraw` (rank hierarchy). diff --git a/_Sidebar.md b/_Sidebar.md index a2f2dfd..aa317b1 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -32,7 +32,7 @@ **Planned** - [Planned Features](Planned-Features) - [Reports Mockup](Reports-Mockup) -- [Crewing Management](README) +- [Crewing Management](Crewing-Module) **Quality** - [Testing](Testing)