Fix types + add better example

Author: joshdover

docs/development/core/public/kibana-plugin-core-public.app.exactroute.md

@@ -18,7 +18,7 @@ exactRoute?: boolean;
 ```ts
 core.application.register({
   id: 'my_app',
-  title: 'My App'
+  title: 'My App',
   exactRoute: true,
   mount: () => { ... },
 })

docs/development/core/public/kibana-plugin-core-public.app.md

@@ -27,7 +27,7 @@ export interface App<HistoryLocationState = unknown>
 |  [mount](./kibana-plugin-core-public.app.mount.md) | <code>AppMount&lt;HistoryLocationState&gt; &#124; AppMountDeprecated&lt;HistoryLocationState&gt;</code> | A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-core-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-core-public.appmountdeprecated.md)<!-- -->. |
 |  [navLinkStatus](./kibana-plugin-core-public.app.navlinkstatus.md) | <code>AppNavLinkStatus</code> | The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) |
 |  [order](./kibana-plugin-core-public.app.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
-|  [searchDeepLinks](./kibana-plugin-core-public.app.searchdeeplinks.md) | <code>AppSearchDeepLink[]</code> | Array of links that represent secondary in-app locations for the app.<!-- -->Used to populate navigational search results (where available). Can be updated using the [App.updater$](./kibana-plugin-core-public.app.updater_.md) observable. See  for more details. |
+|  [searchDeepLinks](./kibana-plugin-core-public.app.searchdeeplinks.md) | <code>AppSearchDeepLink[]</code> | Array of links that represent secondary in-app locations for the app. |
 |  [status](./kibana-plugin-core-public.app.status.md) | <code>AppStatus</code> | The initial status of the application. Defaulting to <code>accessible</code> |
 |  [title](./kibana-plugin-core-public.app.title.md) | <code>string</code> | The title of the application. |
 |  [tooltip](./kibana-plugin-core-public.app.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. |

docs/development/core/public/kibana-plugin-core-public.app.searchdeeplinks.md

@@ -6,10 +6,37 @@
 
 Array of links that represent secondary in-app locations for the app.
 
-Used to populate navigational search results (where available). Can be updated using the [App.updater$](./kibana-plugin-core-public.app.updater_.md) observable. See  for more details.
-
 <b>Signature:</b>
 
 ```typescript
 searchDeepLinks?: AppSearchDeepLink[];
 ```
+
+## Remarks
+
+Used to populate navigational search results (where available). Can be updated using the [App.updater$](./kibana-plugin-core-public.app.updater_.md) observable. See  for more details.
+
+## Example
+
+The `path` property on deep links should not include the application's `appRoute`<!-- -->:
+
+```ts
+core.application.register({
+  id: 'my_app',
+  title: 'My App',
+  searchDeepLinks: [
+    { id: 'sub1', title: 'Sub1', path: '/sub1' },
+    {
+      id: 'sub2',
+      title: 'Sub2',
+      searchDeepLinks: [
+        { id: 'subsub', title: 'SubSub', path: '/sub2/sub' }
+      ]
+    }
+  ],
+  mount: () => { ... },
+})
+
+```
+Will produce deep links on these paths: - `/app/my_app/sub1` - `/app/my_app/sub2/sub`
+

src/core/public/application/types.ts

@@ -225,7 +225,7 @@ export interface App<HistoryLocationState = unknown> {
    * ```ts
    * core.application.register({
    *   id: 'my_app',
-   *   title: 'My App'
+   *   title: 'My App',
    *   exactRoute: true,
    *   mount: () => { ... },
    * })
@@ -239,8 +239,33 @@ export interface App<HistoryLocationState = unknown> {
   /**
    * Array of links that represent secondary in-app locations for the app.
    *
+   * @remarks
    * Used to populate navigational search results (where available).
    * Can be updated using the {@link App.updater$} observable. See {@link AppSubLink} for more details.
+   *
+   * @example
+   * The `path` property on deep links should not include the application's `appRoute`:
+   * ```ts
+   * core.application.register({
+   *   id: 'my_app',
+   *   title: 'My App',
+   *   searchDeepLinks: [
+   *     { id: 'sub1', title: 'Sub1', path: '/sub1' },
+   *     {
+   *       id: 'sub2',
+   *       title: 'Sub2',
+   *       searchDeepLinks: [
+   *         { id: 'subsub', title: 'SubSub', path: '/sub2/sub' }
+   *       ]
+   *     }
+   *   ],
+   *   mount: () => { ... },
+   * })
+   * ```
+   *
+   * Will produce deep links on these paths:
+   * - `/app/my_app/sub1`
+   * - `/app/my_app/sub2/sub`
    */
   searchDeepLinks?: AppSearchDeepLink[];
 }

src/core/public/chrome/nav_links/to_nav_link.test.ts

@@ -28,7 +28,7 @@ const app = (props: Partial<PublicAppInfo> = {}): PublicAppInfo => ({
   status: AppStatus.accessible,
   navLinkStatus: AppNavLinkStatus.default,
   appRoute: `/app/some-id`,
-  subLinks: [],
+  searchDeepLinks: [],
   ...props,
 });