@documentation-robotics/cli 0.2.0 → 0.4.0

package/dist/integrations/github_copilot/skills/dr_11_navigation_layer/SKILL.md

@@ -11,13 +11,13 @@ triggers:
     "redirect",
     "navigation flow"
   ]
-version: 0.8.1
+version: 0.8.3
 ---
 
 # Navigation Layer Skill
 
 **Layer Number:** 10
-**Specification:** Metadata Model Spec v0.8.1
+**Specification:** Metadata Model Spec v0.8.3
 **Purpose:** Defines multi-modal navigation flows, routes, guards, and transitions between views.
 
 ---
@@ -26,13 +26,17 @@ version: 0.8.1
 
 The Navigation Layer captures **navigation and routing**:
 
-- **ROUTES** - URL paths to views
-- **GUARDS** - Authorization checks before navigation
-- **FLOWS** - Multi-step navigation flows
-- **TRANSITIONS** - Navigation between routes
-- **REDIRECTS** - Conditional redirects
-- **CONTEXT** - Navigation context variables
-- **TRACKING** - Analytics and process tracking
+- **GRAPH** - Top-level container for the entire navigation model (`navigationgraph`)
+- **ROUTES** - URL paths to views; types include `public`, `protected`, `redirect`, `alias`, `lazy` (`route`)
+- **ROUTE METADATA** - Auth requirements, layout, keepAlive metadata per route (`routemeta`)
+- **BREADCRUMBS** - Breadcrumb trail configuration per route (`breadcrumbconfig`)
+- **GUARDS** - Pre-navigation authorization/validation checks (`navigationguard`)
+- **GUARD CONDITIONS** - Boolean expressions evaluated by guards (`guardcondition`)
+- **GUARD ACTIONS** - Actions on guard failure: redirect, block, notify, prompt (`guardaction`)
+- **FLOWS** - Multi-step navigation sequences (`navigationflow`)
+- **FLOW STEPS** - Individual steps within a flow (`flowstep`)
+- **TRANSITIONS** - Directed transitions between routes with triggers (`navigationtransition`)
+- **CONTEXT** - Navigation-scoped context variables (`contextvariable`)
 
 This layer uses **Multi-Modal Navigation** supporting web, mobile, voice, and other modalities.
 
@@ -45,20 +49,62 @@ This layer uses **Multi-Modal Navigation** supporting web, mobile, voice, and ot
 > **CLI Introspection:** Run `dr schema types navigation` for the authoritative, always-current list of node types.
 > Run `dr schema node <type-id>` for full attribute details on any type.
 
-### Core Navigation Entities (10 entities)
-
-| Entity Type              | Description                                |
-| ------------------------ | ------------------------------------------ |
-| **Route**                | URL path mapped to view                    |
-| **NavigationGuard**      | Authorization/validation before navigation |
-| **NavigationFlow**       | Multi-step navigation sequence             |
-| **NavigationTransition** | Transition between routes                  |
-| **FlowStep**             | Step in navigation flow                    |
-| **ContextVariable**      | Navigation context data                    |
-| **DataMapping**          | Data passing between routes                |
-| **NotificationAction**   | Navigation-triggered notifications         |
-| **ProcessTracking**      | Business process tracking                  |
-| **FlowAnalytics**        | Navigation analytics                       |
+### Core Navigation Entities (11 entities)
+
+| Entity Type              | Description                                                       |
+| ------------------------ | ----------------------------------------------------------------- |
+| **NavigationGraph**      | Top-level container representing the complete navigation model    |
+| **Route**                | URL path mapped to a view; the core modeling unit                 |
+| **RouteMeta**            | Auth, layout, and lifecycle metadata attached to a route          |
+| **NavigationGuard**      | Authorization/validation check executed before navigation         |
+| **GuardCondition**       | Boolean expression evaluated by a navigation guard                |
+| **GuardAction**          | Action taken when a guard fails (redirect, block, notify, prompt) |
+| **NavigationFlow**       | Multi-step navigation sequence                                    |
+| **FlowStep**             | A single step within a navigation flow                            |
+| **NavigationTransition** | Directed transition between two routes                            |
+| **ContextVariable**      | Navigation-scoped context data passed between routes              |
+| **BreadcrumbConfig**     | Breadcrumb trail configuration for a route                        |
+
+---
+
+## Type Decision Tree
+
+Use this decision tree **before assigning a type** to any navigation element.
+
+```
+Is this the top-level navigation model for an application?
+  → navigation.navigationgraph.*
+
+Is this a URL path/route that maps to a view?
+  → navigation.route.*
+
+Is this metadata about a route (auth requirements, layout, keepAlive)?
+  → navigation.routemeta.*
+
+Is this a breadcrumb configuration for a route?
+  → navigation.breadcrumbconfig.*
+
+Is this a guard that checks conditions before allowing navigation?
+  → navigation.navigationguard.*
+
+Is this a boolean expression/predicate evaluated inside a guard?
+  → navigation.guardcondition.*
+
+Is this the action to take when a guard fails (redirect, block, notify, prompt)?
+  → navigation.guardaction.*
+
+Is this a named multi-step navigation sequence (wizard, checkout, onboarding)?
+  → navigation.navigationflow.*
+
+Is this a single step within a navigation flow?
+  → navigation.flowstep.*
+
+Is this a directed transition between two specific routes with a trigger?
+  → navigation.navigationtransition.*
+
+Is this a context variable scoped to the navigation session?
+  → navigation.contextvariable.*
+```
 
 ---
 
@@ -74,19 +120,75 @@ Activate when the user:
 
 ---
 
-## Cross-Layer Relationships
-
-**Outgoing (Navigation → Other Layers):**
-
-- `view-ref` → UX Layer (which view does this route show?)
-- `business.realizes-process` → Business Layer (what process does this flow realize?)
-- `security.required-roles` → Security Layer (authorization requirements)
-- `apm.flow-metrics` → APM Layer (navigation analytics)
+## Intra-Layer Relationships
+
+A guard `evaluates` its condition, `triggers` its action on denial and `protects` what it guards. A
+transition leaves its source route (`flows-to`) and `navigates-to` its destination. Context variables
+are passive state that steps, guards, conditions, actions and transitions `accesses`. Navigation
+never reaches the data store directly, and reaches the business through the product workflows that
+flows and steps realize.
+
+| Source Type          | Predicate    | Target Type          | Example                                                       |
+| -------------------- | ------------ | -------------------- | ------------------------------------------------------------- |
+| NavigationGraph      | composes     | Route                | "Web App Navigation" composes "User Profile Route"            |
+| NavigationGraph      | composes     | NavigationTransition | "Web App Navigation" composes "Cart To Shipping"              |
+| NavigationGraph      | aggregates   | NavigationFlow       | "Web App Navigation" aggregates "Checkout Flow"               |
+| NavigationGraph      | aggregates   | NavigationGuard      | "Web App Navigation" aggregates "Auth Guard"                  |
+| NavigationGraph      | aggregates   | BreadcrumbConfig     | "Web App Navigation" aggregates "Profile Breadcrumb"          |
+| Route                | composes     | RouteMeta            | "User Profile Route" composes "Profile Route Meta"            |
+| Route                | aggregates   | Route                | "Settings Route" aggregates "Settings Security Route"         |
+| Route                | navigates-to | Route                | "Legacy Account Route" navigates-to "Account Settings Route"  |
+| Route                | flows-to     | NavigationTransition | "Cart Route" flows-to "Cart To Shipping" (its source route)   |
+| BreadcrumbConfig     | references   | RouteMeta            | "Profile Breadcrumb" references "Profile Route Meta" (labels) |
+| BreadcrumbConfig     | references   | Route                | "Profile Breadcrumb" references "Dashboard Route"             |
+| NavigationGuard      | protects     | Route                | "Auth Guard" protects "User Profile Route"                    |
+| NavigationGuard      | evaluates    | GuardCondition       | "Auth Guard" evaluates "Is Authenticated"                     |
+| NavigationGuard      | triggers     | GuardAction          | "Auth Guard" triggers "Redirect To Login"                     |
+| GuardCondition       | accesses     | ContextVariable      | "Is Authenticated" accesses "Session Token"                   |
+| GuardAction          | navigates-to | Route                | "Redirect To Login" navigates-to "Login Route"                |
+| NavigationFlow       | composes     | FlowStep             | "Checkout Flow" composes "Cart Review Step"                   |
+| NavigationFlow       | aggregates   | ContextVariable      | "Checkout Flow" aggregates "Cart ID"                          |
+| NavigationGuard      | protects     | NavigationFlow       | "Cart Not Empty Guard" protects "Checkout Flow"               |
+| FlowStep             | navigates-to | Route                | "Cart Review Step" navigates-to "Cart Route"                  |
+| FlowStep             | accesses     | ContextVariable      | "Payment Step" accesses "Cart ID"                             |
+| NavigationTransition | navigates-to | Route                | "Cart To Shipping" navigates-to "Shipping Route"              |
+| NavigationGuard      | protects     | NavigationTransition | "Valid Address Guard" protects "Shipping To Payment"          |
 
-**Incoming (Other Layers → Navigation):**
+---
 
-- UX Layer → Navigation (views reference routes)
-- Business Layer → Navigation (processes trigger flows)
+## Cross-Layer References
+
+### Outgoing References (Navigation → Other Layers)
+
+| Source Type          | Predicate  | Target Type                        | Example                                                          |
+| -------------------- | ---------- | ---------------------------------- | ---------------------------------------------------------------- |
+| Route                | maps-to    | `ux.view`                          | "User Profile Route" maps-to "User Profile View"                 |
+| RouteMeta            | uses       | `ux.layoutconfig`                  | "Profile Route Meta" uses "Authenticated Shell Layout"           |
+| NavigationTransition | triggers   | `ux.statetransition`               | "Cart To Shipping" triggers "Cart Submitted Transition"          |
+| Route                | requires   | `security.permission`              | "Admin Users Route" requires "users:read"                        |
+| NavigationGuard      | requires   | `security.role`                    | "Auth Guard" requires "Authenticated User"                       |
+| NavigationGuard      | realizes   | `security.securitypolicy`          | "Admin Guard" realizes "Admin Access Policy"                     |
+| ContextVariable      | maps-to    | `api.parameter`                    | "User ID" maps-to "userId path parameter"                        |
+| Route                | lazy-loads | `application.applicationcomponent` | "Reports Route" lazy-loads "Reports Module"                      |
+| Route                | uses       | `application.applicationservice`   | "Order Detail Route" uses "Order Service" (resolver)             |
+| NavigationFlow       | realizes   | `product.userworkflow`             | "Onboarding Flow" realizes "New User Onboarding"                 |
+| FlowStep             | realizes   | `product.workflowstep`             | "Payment Step" realizes "Enter Payment Details"                  |
+| Route                | satisfies  | `motivation.requirement`           | "Order History Route" satisfies "Customers Can View Past Orders" |
+
+### Incoming References (Other Layers → Navigation)
+
+| Source Type                  | Predicate | Target Type          | Example                                                             |
+| ---------------------------- | --------- | -------------------- | ------------------------------------------------------------------- |
+| `api.operation`              | serves    | Route                | "GET /users/{id}" serves "User Profile Route" (its loader calls it) |
+| `api.operation`              | serves    | NavigationGuard      | "GET /auth/session" serves "Auth Guard"                             |
+| `apm.span`                   | monitors  | Route                | "Route Change Span" monitors "User Profile Route"                   |
+| `apm.span`                   | monitors  | NavigationFlow       | "Checkout Journey Span" monitors "Checkout Flow"                    |
+| `apm.metricinstrument`       | monitors  | Route                | "route_load_time" monitors "User Profile Route"                     |
+| `apm.metricinstrument`       | monitors  | NavigationTransition | "checkout_step_dropoff" monitors "Shipping To Payment"              |
+| `testing.testcasesketch`     | tests     | Route                | "Deep Link To Profile" tests "User Profile Route"                   |
+| `testing.testcasesketch`     | tests     | NavigationGuard      | "Anonymous User Redirected" tests "Auth Guard"                      |
+| `testing.testcasesketch`     | tests     | NavigationFlow       | "Complete Checkout" tests "Checkout Flow"                           |
+| `testing.testcoveragetarget` | covers    | Route                | "User Profile" target covers "User Profile Route"                   |
 
 ---
 
@@ -105,23 +207,48 @@ Activate when the user:
 ## Common Commands
 
 ```bash
-# Add route
-dr add navigation route --name "User Profile Route" --property path=/profile/:id
+# Add navigation graph (one per application)
+dr add navigation navigationgraph "My App Navigation"
+
+# Add route (types: public | protected | redirect | alias | lazy)
+dr add navigation route "User Profile Route" --description "User profile page route"
+
+# Add route metadata
+dr add navigation routemeta "Profile Route Meta"
+
+# Add breadcrumb configuration
+dr add navigation breadcrumbconfig "Profile Breadcrumb"
 
 # Add navigation guard
-dr add navigation navigation-guard --name "Auth Guard"
+dr add navigation navigationguard "Auth Guard"
+
+# Add guard condition
+dr add navigation guardcondition "Is Authenticated"
+
+# Add guard action (on failure)
+dr add navigation guardaction "Redirect To Login"
 
 # Add navigation flow
-dr add navigation navigation-flow --name "Checkout Flow"
+dr add navigation navigationflow "Checkout Flow"
+
+# Add flow step
+dr add navigation flowstep "Cart Review Step"
 
-# List routes
-dr list navigation route
+# Add transition between routes
+dr add navigation navigationtransition "Cart To Shipping"
+
+# Add context variable
+dr add navigation contextvariable "Cart ID"
+
+# List by type
+dr list navigation --type route
+dr list navigation --type navigationguard
 
 # Validate navigation layer
-dr validate --layer navigation
+dr validate --layers navigation
 
 # Export navigation map
-dr export --layer navigation --format mermaid
+dr export plantuml --layers navigation
 ```
 
 ---
@@ -134,10 +261,9 @@ name: "User Profile Route"
 type: route
 properties:
   path: /profile/:userId
-  view-ref: ux.view.user-profile
   guards:
-    - navigation.guard.authentication
-    - navigation.guard.profile-ownership
+    - navigation.navigationguard.authentication
+    - navigation.navigationguard.profile-ownership
   parameters:
     - name: userId
       type: string
@@ -155,15 +281,15 @@ properties:
   dataMapping:
     - source: route.params.userId
       target: view.data.userId
-  security:
-    required-roles:
-      - security.role.authenticated-user
-  business:
-    realizes-process: business.process.profile-management
-  apm:
-    flow-metrics:
-      - apm.metric.profile-view-count
-      - apm.metric.profile-load-time
+```
+
+Record the cross-layer links as relationships, not as properties:
+
+```bash
+dr relationship add navigation.route.user-profile ux.view.user-profile --predicate maps-to
+dr relationship add navigation.navigationguard.authentication security.role.authenticated-user --predicate requires
+dr relationship add api.operation.get-user navigation.route.user-profile --predicate serves
+dr relationship add apm.metricinstrument.profile-load-time navigation.route.user-profile --predicate monitors
 ```
 
 ---
@@ -171,9 +297,9 @@ properties:
 ## Example: Multi-Step Checkout Flow
 
 ```yaml
-id: navigation.flow.checkout
+id: navigation.navigationflow.checkout
 name: "Checkout Flow"
-type: navigation-flow
+type: navigationflow
 properties:
   steps:
     - id: cart-review
@@ -196,33 +322,56 @@ properties:
     - from: cart-review
       to: shipping-address
       trigger: next-button
-      guard: cart-not-empty
+      guard: navigation.navigationguard.cart-not-empty
     - from: shipping-address
       to: payment
       trigger: next-button
-      guard: valid-address
+      guard: navigation.navigationguard.valid-address
     - from: payment
       to: confirmation
       trigger: submit
-      guard: payment-successful
+      guard: navigation.navigationguard.payment-successful
   context:
     - cartId
     - selectedAddress
     - paymentMethod
-  analytics:
-    trackStepCompletion: true
-    trackAbandonmentRate: true
-  business:
-    realizes-process: business.process.checkout
 ```
 
+```bash
+dr relationship add navigation.navigationflow.checkout product.userworkflow.checkout --predicate realizes
+dr relationship add navigation.navigationflow.checkout navigation.flowstep.cart-review --predicate composes
+dr relationship add navigation.flowstep.cart-review navigation.route.cart --predicate navigates-to
+```
+
+---
+
+## Coverage Completeness Checklist
+
+Before declaring navigation layer extraction complete, verify each type was considered:
+
+- [ ] `navigation.navigationgraph.*` — Top-level navigation model container
+- [ ] `navigation.route.*` — URL path to view mappings (core unit)
+- [ ] `navigation.routemeta.*` — Auth, layout, keepAlive metadata per route
+- [ ] `navigation.breadcrumbconfig.*` — Breadcrumb trail configuration
+- [ ] `navigation.navigationguard.*` — Pre-navigation authorization/validation checks
+- [ ] `navigation.guardcondition.*` — Boolean expressions evaluated by guards
+- [ ] `navigation.guardaction.*` — Actions taken on guard failure
+- [ ] `navigation.navigationflow.*` — Multi-step navigation sequences
+- [ ] `navigation.flowstep.*` — Individual steps within flows
+- [ ] `navigation.navigationtransition.*` — Directed transitions between routes
+- [ ] `navigation.contextvariable.*` — Navigation-scoped context data
+
+If any type has ZERO elements, explicitly decide:
+"This type doesn't apply to this codebase" with reasoning.
+
 ---
 
 ## Pitfalls to Avoid
 
-- ❌ Missing authentication guards on protected routes
-- ❌ Not validating route parameters
-- ❌ Complex flows without clear step definitions
-- ❌ Not tracking navigation analytics
-- ❌ Missing cross-layer links to UX views
-- ❌ No error/fallback routes defined
+- ❌ Missing authentication guards on protected routes — use `navigationguard` + `guardcondition` + `guardaction` together
+- ❌ Using `navigation.guard.*` or `navigation.flow.*` as element IDs — correct types are `navigationguard` and `navigationflow`
+- ❌ Not decomposing guards into conditions (`guardcondition`) and actions (`guardaction`) — model these as separate elements
+- ❌ Complex flows without explicit `flowstep` elements — each step in a flow should be a distinct `flowstep`
+- ❌ Missing `routemeta` for protected routes — auth requirements belong in `routemeta`, not embedded in route properties
+- ❌ Missing cross-layer links — each route should `maps-to` a `ux.view`, and flows should `realizes` a `business.businessprocess` or `product.userworkflow`
+- ❌ No error/fallback routes defined — model these as `route` with `type: redirect`