chore: fix link issue; improve env links/assets

Author: yowainwright

.env.example

@@ -2,4 +2,6 @@ SYNC_LIFECYCLE_DOCS=
 GITHUB_TOKEN=
 UI_BRANCH=main
 CORE_BRANCH=main
-LC_DOCS_PUBLISH=
+LC_DOCS_PUBLISH=
+NEXT_PUBLIC_DEV_ENV=local
+DEV_ENV=local

next-env.d.ts

@@ -1,19 +1,3 @@
-/**
- * Copyright 2025 GoodRx, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
 

next.config.mjs

@@ -16,6 +16,8 @@
 
 import nextra from "nextra";
 import { remarkCodeHike, recmaCodeHike } from "codehike/mdx";
+// eslint-disable-next-line no-undef
+const isLocal = process.env?.NEXT_PUBLIC_DEV_ENV === 'local';
 
 /** @type {import('codehike/mdx').CodeHikeConfig} */
 export const chConfig = {
@@ -45,8 +47,8 @@ const nextConfig = {
   output: 'export',
   pageExtensions: ["ts", "tsx", "js", "jsx", "md", "mdx", "css"],
   reactStrictMode: true,
-  assetPrefix: '/lifecycle-docs',
-  basePath: '/lifecycle-docs',
+  assetPrefix:  !isLocal ? '/lifecycle-docs' : '',
+  basePath: !isLocal ? '/lifecycle-docs' : '',
   eslint: {
     dirs: ["src"],
     ignoreDuringBuilds: true,

scripts/generateJsonSchema.ts

@@ -35,7 +35,7 @@ const octokit = new Octokit({ auth });
 export const fetchFileFromRepo = async ({
   owner = "goodrxoss",
   repo = "lifecycle",
-  path = "docs/schema/yaml/2.3.0.yaml",
+  path = "docs/schema/yaml/1.0.0.yaml",
   branch = "main",
   debug = false,
 }: FetchFileOptions): Promise<string> => {
@@ -87,7 +87,7 @@ export const syncYamlFile = async (options: SyncOptions) => {
     owner = "goodrxoss",
     repo = "lifecycle",
     // docs/schema/yaml/2.3.0.yaml
-    path = "docs/schema/yaml/2.3.0.yaml",
+    path = "docs/schema/yaml/1.0.0.yaml",
     dest = "src/lib/data/lifecycle-schema",
     name = "lifecycle",
     debug = false,

scripts/generateMeta.ts

@@ -25,6 +25,25 @@ import { join } from "node:path";
 import matter from "gray-matter";
 import { Command } from "commander";
 
+const year = new Date().getFullYear();
+const licenseString = `/*!
+ * @license
+ * Copyright ${year} GoodRx, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+`;
+
 const program = new Command();
 
 export async function generateMetaFiles(directoryPath, isDebugging) {
@@ -66,8 +85,11 @@ export async function generateMetaFiles(directoryPath, isDebugging) {
   const mergedMetaData = { ...existingMetaData, ...metaData };
   if (isDebugging)
     console.log("merged data", { existingMetaData, metaData, mergedMetaData });
+
   const metaContent = `export default ${JSON.stringify(mergedMetaData, null, 2)};`;
-  writeFileSync(metaFilePath, metaContent);
+  const content = licenseString + "\n" + metaContent + "\n";
+
+  writeFileSync(metaFilePath, content);
 }
 
 program

src/components/home/main/index.tsx

@@ -38,7 +38,7 @@ export const Main = () => {
           <div className="my-6 flex justify-center md:mb-0 md:justify-end">
             <Link
               className={`${buttonVariants()} col-span-1 col-end-3`}
-              href="/docs/getting-started"
+              href="/docs/getting-started/create-environment"
             >
               Get Started
             </Link>

src/components/image/index.tsx

@@ -51,10 +51,12 @@ export const DefinedImage = ({
   alt = "",
   width = 800,
   height = 500,
-}: DefinedImageProps) =>
-  width && height ? (
+}: DefinedImageProps) => {
+  const isLocal = process.env.NEXT_PUBLIC_DEV_ENV === "local";
+  const currentSrc = !isLocal ? `/lifecycle-docs${src}` : src;
+  return width && height ? (
     <Image
-      src={`/lifecycle-docs${src}`}
+      src={currentSrc}
       className="absolute inset-0 h-full w-full"
       alt={alt}
       width={width}
@@ -63,6 +65,7 @@ export const DefinedImage = ({
   ) : (
     <img src={src} className="absolute inset-0 h-full w-full" alt={alt} />
   );
+};
 
 export default dynamic(() => Promise.resolve(LifecycleDocsImg), {
   loading: () => <Loader />,

src/pages/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,4 +38,4 @@ export default {
     "title": "Tags",
     "type": "page"
   }
-};
+};

src/pages/articles/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,4 +19,4 @@ export default {
   "introduction": {
     "title": "Introducing Lifecycle"
   }
-};
+};

src/pages/docs/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -48,4 +49,4 @@ export default {
   "----": {
     "type": "separator"
   }
-};
+};

src/pages/docs/features/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,4 +28,4 @@ export default {
   "service-dependencies": {
     "title": "Service Dependencies"
   }
-};
+};

src/pages/docs/getting-started/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,4 +34,4 @@ export default {
   "terminology": {
     "title": "Terminology"
   }
-};
+};

src/pages/docs/schema/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,4 +22,4 @@ export default {
   "full": {
     "title": "All at once"
   }
-};
+};

src/pages/docs/setup/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,4 +31,4 @@ export default {
   "configure-lifecycle": {
     "title": "Additional Configuration"
   }
-};
+};

src/pages/docs/tips/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,4 +22,4 @@ export default {
   "telemetry": {
     "title": "Telemetry"
   }
-};
+};

src/pages/docs/troubleshooting/_meta.ts

@@ -1,4 +1,5 @@
-/**
+/*!
+ * @license
  * Copyright 2025 GoodRx, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,4 +25,4 @@ export default {
   "github-app-webhooks": {
     "title": "Missing PR comment"
   }
-};
+};