--> Wiki Guide

Wiki Guide

TIB-Trader internal wiki guide

The wiki renders every .md file in docs/ at the top level only. Files in subfolders (e.g., docs/codex/) are ignored so you can keep scratch notes separate from published docs. Drop new pages in docs/ to publish immediately; no code change required.

Suggested sections to add/maintain: - status.md — current build status and in‑progress items. - main-menu.md — how the Account + Menu dropdowns work and where they appear. - ui-index.md — UI element IDs (data-ui-key) and how to sync them into the database. - ops-smoke.md — how to run health and Playwright smoke checks, where logs live. - onboarding.md — how to get a dev environment running (env files, network, migrations, test users). - deployment.md — production deploy steps, certbot renewal, Docker volume naming, health checks. - security.md — roles/RBAC, danger-zone password, HSTS/CSP/rate limits, backup/restore, encryption keys. - observability.md — where logs live (docker/fluent-bit/logs), how to clear (scripts/shell/61_clear_logs.sh), and future metrics plan.

Editing tips: - Keep titles short; first H1 becomes the page title. - Use relative links between docs (e.g., [Deploy](deployment.md)). - Avoid secrets in wiki pages; reference env var names instead.

Back to wiki home