flatrate / flarum-forum-navigation

v1.0.0 2026-09-08 19:05 UTC

Requires

• php: ^8.1
• flarum/core: ^1.8.5

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• navigation
• community
• sidebar
• flarum
• brands

Published on Packagist.org on 2026-09-08 22:13 UTC

README

FlatRate.wiki presentation navigation for Flarum 1.8.x.

What it does

• Replaces the native flat primary-tag sideNav presentation with:
  • Community → /community
  • Technician Topics → /t/general-shop-discussion
  • Brands expandable tree (41 boards; GM/CDJR nesting preserved)
• Serves a FlatRate-owned Community page with Start Here CTA and non-interactive General Live coming-soon state (GENERAL_LIVE_AVAILABLE=false)
• Embeds a generated navigation runtime manifest asset; does not read the main wiki repo at runtime

Hard boundaries

PRODUCTION_INSTALL=false in FORUM-IA-010C1
LIVE_SIDEBAR_CHANGE=false
LIVE_TAG_RENAME=false
FLARUM_PARENT_GRAPH_CHANGED=false

Disabling this extension restores native Flarum sideNav without mutating tag IDs, slugs, names, or parent graph.

Extension identity

Field	Value
Composer	flatrate/flarum-forum-navigation
Extension ID	flatrate-forum-navigation
Namespace	FlatRate\ForumNavigation\

Build

cd js
npm ci
npm run build

Tests

composer install
composer test

Manifest sync

The control repo generates configs/forum/navigation-runtime-manifest.json and syncs it into resources/navigation-runtime-manifest.json.

Package CI

GitHub Actions validates Composer, PHPUnit, the embedded navigation manifest (+ provenance), JS build, and a disposable Flarum 1.8.19 path-install smoke.

php scripts/validate-manifest.php
bash scripts/ci-flarum-install-smoke.sh
BASE_URL=http://127.0.0.1:8080 bash scripts/disposable-smoke.sh

Provenance for the embedded manifest is recorded in resources/navigation-runtime-manifest.provenance.json (no runtime network dependency).