earnOS Navigator

UI Folder Structure

Owner: Group PMO Reviewed: 2026-02-24 Read: 1 min Repo: earnOS
ATAGAGHALPEBS

Summary

site/

Decision Points

  • `layouts/`: static page shells and doc page composition.
  • `components/nav/`: sticky search, switchers, breadcrumbs, and recent docs.
  • `components/briefing/`: summary and decision-support modules.
  • `styles/tokens.css`: type scale, spacing, colors, elevation, focus rings.
  • `scripts/`: progressive enhancement only.

UI Folder Structure

site/
  src/
    layouts/
      app-shell.html
      doc-page.html
    components/
      nav/
        global-search.html
        domain-switcher.html
        entity-switcher.html
        recent-docs.html
        breadcrumbs.html
      briefing/
        summary-card.html
        decision-points.html
        progress-bar.html
      search/
        command-palette.html
        search-results.html
      common/
        badge.html
        chip.html
        details-block.html
    styles/
      tokens.css
      base.css
      layout.css
      components.css
      utilities.css
    scripts/
      search.js
      recent-docs.js
      progress.js
      nav-drawer.js
      shortcuts.js
    data/
      nav-index.json
      search-index.json
    pages/
      index.html
      search.html
      docs/

File Responsibilities

  • layouts/: static page shells and doc page composition.
  • components/nav/: sticky search, switchers, breadcrumbs, and recent docs.
  • components/briefing/: summary and decision-support modules.
  • styles/tokens.css: type scale, spacing, colors, elevation, focus rings.
  • scripts/: progressive enhancement only.
  • data/: generated indexes from markdown frontmatter.

Build Pipeline Requirements

  1. Parse markdown and frontmatter into JSON indexes.
  2. Generate static HTML pages.
  3. Embed domain/entity navigation indexes.
  4. Validate canonical links during CI.