Wiki Editing & File Naming Notes

Owner(s): CrowdPM team | Last updated: 2026-03-08 | Status: Production

Wiki Editing & File Naming Notes

Purpose

This page explains how to keep the CrowdPM wiki maintainable and synchronized with the repository.

File/page naming convention

Use the GitHub wiki page title as the file name with .md.

Examples:

• Home.md
• Project Overview & Goals.md
• Requirements & Scope.md
• System Design (with diagrams).md
• Developer Setup & Project Conventions.md

For legacy page names that encode slashes oddly in URLs, keep the existing page/file name stable unless you intentionally rename the page and update incoming links.

Recommended page header format

Start each maintained page with a one-line metadata header such as:

Owner(s): CrowdPM team | Last updated: YYYY-MM-DD | Status: Updated draft

This keeps status visible without requiring a separate template system.

Link convention

Within the wiki, prefer explicit internal wiki links such as:

• [[Home]]
• [[Requirements & Scope]]
• [[System Design (with diagrams)]]

This is easier to maintain than long URL-based links.

What belongs in the wiki

Use the wiki for:

• overview pages;
• architecture pages;
• onboarding and contributor guidance;
• demo narratives;
• release summaries;
• handoff context;
• project-specific development standards.

What belongs in the repository docs

Keep exact operational runbooks in the repository for:

• local setup and verification commands;
• demo deployment procedures;
• production release steps;
• exact env variable truth;
• command-line snippets that may change frequently.

Recommended repo locations:

• README.md
• docs/development.md
• docs/demo.md
• docs/prod.md
• env example files

Sync rule

When any of the following changes, update both the repo docs and the wiki pages that reference them:

• route families;
• auth/role semantics;
• environment variables;
• smoke-test steps;
• deployment process;
• data model names used in the docs.

Pages that should usually move together

Product/architecture cluster

• Home
• Project Overview & Goals
• Requirements & Scope
• System Design (with diagrams)
• How We Use Deck.gl

Contributor/operations cluster

• Developer Setup & Project Conventions
• Demo Scripts
• Deployment Guide
• Team Standards for Development
• Release Plan & Notes (milestones---demos)
• Handoff, Reflection, and Future Work

Change-review checklist for wiki edits

Before marking a wiki update done, ask:

1. Does the wording match the current code/docs surface?
2. Does it avoid claiming unshipped features?
3. Does it distinguish guest, owner, moderator, and super-admin behavior correctly?
4. Does it point contributors to the right runbook?
5. Are internal wiki links still valid?

Recommended upload workflow

Option A — Git clone the wiki repo

Use the GitHub wiki repository so page history remains clear.

Typical pattern:

git clone https://github.com/Denuo-Web/CrowdPMPlatform.wiki.git
cd CrowdPMPlatform.wiki
# copy updated .md files into place
git add .
git commit -m "Update wiki to match current repo/docs"
git push

Option B — Manual page edits in the browser

Use browser editing only for small edits. For large synchronized updates, prefer the wiki git repository.

Pages intentionally left to project history/process

The following pages are not good candidates for bulk auto-regeneration from code alone and should usually be edited manually by the team:

• Decision Log (short design notes)
• Architecture Decision Records (ADRs)
• Meeting Notes & Decisions Log
• GenAI Usage Log & Citations