From fad694e1dc35a3d002a9bb4cd866c7e2dca32e63 Mon Sep 17 00:00:00 2001
From: Alan Agius <alanagius@google.com>
Date: Tue, 5 Nov 2024 13:08:31 +0000
Subject: [PATCH 1/2] docs: enhance documentation by adding `@see` references

Improve the documentation `adev` API reference by incorporating `@see` references. This addition enhances cross-referencing within the documentation, making it easier for users to navigate related content and gain better context.
---
 packages/angular/ssr/src/routes/route-config.ts | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/packages/angular/ssr/src/routes/route-config.ts b/packages/angular/ssr/src/routes/route-config.ts
index ac6fd6203bca..7d72dd0bf049 100644
--- a/packages/angular/ssr/src/routes/route-config.ts
+++ b/packages/angular/ssr/src/routes/route-config.ts
@@ -10,6 +10,8 @@ import { EnvironmentProviders, InjectionToken, makeEnvironmentProviders } from '
 
 /**
  * Different rendering modes for server routes.
+ * @see {@link provideServerRoutesConfig}
+ * @see {@link ServerRoute}
  * @developerPreview
  */
 export enum RenderMode {
@@ -29,7 +31,7 @@ export enum RenderMode {
 /**
  * Defines the fallback strategies for Static Site Generation (SSG) routes when a pre-rendered path is not available.
  * This is particularly relevant for routes with parameterized URLs where some paths might not be pre-rendered at build time.
- *
+ * @see {@link ServerRoutePrerenderWithParams}
  * @developerPreview
  */
 export enum PrerenderFallback {
@@ -68,6 +70,7 @@ export interface ServerRouteCommon {
 
 /**
  * A server route that uses AppShell rendering mode.
+ * @see {@link RenderMode}
  */
 export interface ServerRouteAppShell extends Omit<ServerRouteCommon, 'headers' | 'status'> {
   /** Specifies that the route uses AppShell rendering mode. */
@@ -76,6 +79,7 @@ export interface ServerRouteAppShell extends Omit<ServerRouteCommon, 'headers' |
 
 /**
  * A server route that uses Client-Side Rendering (CSR) mode.
+ * @see {@link RenderMode}
  */
 export interface ServerRouteClient extends ServerRouteCommon {
   /** Specifies that the route uses Client-Side Rendering (CSR) mode. */
@@ -84,6 +88,7 @@ export interface ServerRouteClient extends ServerRouteCommon {
 
 /**
  * A server route that uses Static Site Generation (SSG) mode.
+ * @see {@link RenderMode}
  */
 export interface ServerRoutePrerender extends Omit<ServerRouteCommon, 'status'> {
   /** Specifies that the route uses Static Site Generation (SSG) mode. */
@@ -95,6 +100,9 @@ export interface ServerRoutePrerender extends Omit<ServerRouteCommon, 'status'>
 
 /**
  * A server route configuration that uses Static Site Generation (SSG) mode, including support for routes with parameters.
+ * @see {@link RenderMode}
+ * @see {@link ServerRoutePrerender}
+ * @see {@link PrerenderFallback}
  */
 export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerender, 'fallback'> {
   /**
@@ -138,6 +146,7 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
 
 /**
  * A server route that uses Server-Side Rendering (SSR) mode.
+ *  @see {@link RenderMode}
  */
 export interface ServerRouteServer extends ServerRouteCommon {
   /** Specifies that the route uses Server-Side Rendering (SSR) mode. */
@@ -146,6 +155,7 @@ export interface ServerRouteServer extends ServerRouteCommon {
 
 /**
  * Server route configuration.
+ * @see {@link provideServerRoutesConfig}
  * @developerPreview
  */
 export type ServerRoute =
@@ -166,6 +176,7 @@ export const SERVER_ROUTES_CONFIG = new InjectionToken<ServerRoute[]>('SERVER_RO
  *
  * @param routes - An array of server routes to be provided.
  * @returns An `EnvironmentProviders` object that contains the server routes configuration.
+ * @see {@link ServerRoute}
  * @developerPreview
  */
 export function provideServerRoutesConfig(routes: ServerRoute[]): EnvironmentProviders {

From feac685f44595046d3b6103d0788f4389f0fc95e Mon Sep 17 00:00:00 2001
From: Alan Agius <alanagius@google.com>
Date: Tue, 5 Nov 2024 13:58:46 +0000
Subject: [PATCH 2/2] docs(@angular/ssr): add missing `@developerPreview`
 annotations

Added `@developerPreview` annotations to the relevant API functions and properties within the `@angular/ssr` package. This change ensures that the documentation accurately reflects the preview status of these elements, clarifying their intended use and stability level for developers.
---
 packages/angular/ssr/src/routes/route-config.ts | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/packages/angular/ssr/src/routes/route-config.ts b/packages/angular/ssr/src/routes/route-config.ts
index 7d72dd0bf049..88df23721d73 100644
--- a/packages/angular/ssr/src/routes/route-config.ts
+++ b/packages/angular/ssr/src/routes/route-config.ts
@@ -56,6 +56,7 @@ export enum PrerenderFallback {
 
 /**
  * Common interface for server routes, providing shared properties.
+ * @developerPreview
  */
 export interface ServerRouteCommon {
   /** The path associated with this route. */
@@ -71,6 +72,7 @@ export interface ServerRouteCommon {
 /**
  * A server route that uses AppShell rendering mode.
  * @see {@link RenderMode}
+ * @developerPreview
  */
 export interface ServerRouteAppShell extends Omit<ServerRouteCommon, 'headers' | 'status'> {
   /** Specifies that the route uses AppShell rendering mode. */
@@ -80,6 +82,7 @@ export interface ServerRouteAppShell extends Omit<ServerRouteCommon, 'headers' |
 /**
  * A server route that uses Client-Side Rendering (CSR) mode.
  * @see {@link RenderMode}
+ * @developerPreview
  */
 export interface ServerRouteClient extends ServerRouteCommon {
   /** Specifies that the route uses Client-Side Rendering (CSR) mode. */
@@ -89,6 +92,7 @@ export interface ServerRouteClient extends ServerRouteCommon {
 /**
  * A server route that uses Static Site Generation (SSG) mode.
  * @see {@link RenderMode}
+ * @developerPreview
  */
 export interface ServerRoutePrerender extends Omit<ServerRouteCommon, 'status'> {
   /** Specifies that the route uses Static Site Generation (SSG) mode. */
@@ -103,6 +107,7 @@ export interface ServerRoutePrerender extends Omit<ServerRouteCommon, 'status'>
  * @see {@link RenderMode}
  * @see {@link ServerRoutePrerender}
  * @see {@link PrerenderFallback}
+ * @developerPreview
  */
 export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerender, 'fallback'> {
   /**
@@ -146,7 +151,8 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
 
 /**
  * A server route that uses Server-Side Rendering (SSR) mode.
- *  @see {@link RenderMode}
+ * @see {@link RenderMode}
+ * @developerPreview
  */
 export interface ServerRouteServer extends ServerRouteCommon {
   /** Specifies that the route uses Server-Side Rendering (SSR) mode. */