Wiki V1.0
Powered by

# Repository Guidelines

# Project Structure & Module Organization

This repository is a Retype-powered documentation site for Integrated Business Planning (IBP).

  • Root markdown pages: readme.md, about.md, faq.md, roadmap.md
  • Topic collections: concepts/, data/, templates/, anti-patterns/
  • Navigation indexes: concepts/readme.md, data/readme.md, templates/readme.md, anti-patterns/readme.md
  • Site config: retype.yml
  • Deployment artifacts: Dockerfile, docker-compose.yml, DEPLOYMENT.md
  • Build output: .retype/ (generated)

# Build, Test, and Development Commands

  • npm run dev: Starts local Retype preview with file watching.
  • npm run build: Generates static site output in .retype/.
  • docker compose up -d --build: Builds and runs the production container locally or on VPS.

Use npm run build before opening a PR to catch broken links or syntax issues in docs.

# Coding Style & Naming Conventions

  • Write content in Markdown with clear, sectioned headings (#, ##, ###).
  • Prefer concise paragraphs and short bullet lists over long prose blocks.
  • Use lowercase, hyphen/underscore-friendly filenames (for example, supply_planning.md).
  • Keep front matter consistent where used (for example, icon, label in root pages).
  • Maintain existing directory taxonomy; add new pages to the relevant domain folder.

# Testing Guidelines

There is no dedicated automated test framework in this repo. Validation is documentation-build based:

  • Run npm run build for every change.
  • Manually spot-check affected pages in npm run dev preview.
  • Verify navigation links and cross-references when adding or moving files.

# Commit & Pull Request Guidelines

Current history favors short, imperative commit messages (for example, add docker-compose for Traefik deployment, updated index).

  • Keep subject lines brief and action-oriented.
  • Group related documentation updates into one commit.
  • In PRs, include:
    • What changed and why
    • Key files/folders touched
    • Preview notes or screenshots for navigation/structure changes
    • Linked issue (if applicable)

# Security & Configuration Tips

  • Do not commit secrets, API tokens, or environment-specific credentials.
  • Treat DEPLOYMENT.md and docker-compose.yml as production-facing docs; keep hostnames, container names, and network assumptions accurate.