Move docs under website (#1801)

.chronus/changes/move-docs-2024-10-4-23-37-28.md

@@ -0,0 +1,14 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: internal
+packages:
+  - "@azure-tools/typespec-autorest-canonical"
+  - "@azure-tools/typespec-autorest"
+  - "@azure-tools/typespec-azure-core"
+  - "@azure-tools/typespec-azure-portal-core"
+  - "@azure-tools/typespec-azure-resource-manager"
+  - "@azure-tools/typespec-azure-rulesets"
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+Move docs under website

.gitignore

@@ -201,7 +201,7 @@ packages/samples/test/output/azure/templates-contoso/setup.*
 # JetBrains Rider
 .idea/
 
-docs/**/js-api/
+**/docs/**/js-api/
 
 # vitest temporary files
 **/vitest.config.ts.timestamp*

.vscode/launch.json

@@ -207,7 +207,7 @@
         "doc",
         "${workspaceFolder}/packages/typespec-azure-resource-manager",
         "--enable-experimental",
-        "--output-dir=../../docs/libraries/azure-resource-manager/reference"
+        "--output-dir=../../website/src/content/docs/docs/libraries/azure-resource-manager/reference"
       ],
       "smartStep": true,
       "sourceMaps": true,

docs/readme.md

@@ -0,0 +1,13 @@
+## Docs moved
+
+Docs have moved into the website folder [../website/src/content/docs/docs](../website/src/content/docs/docs)
+
+### For reference
+
+This is an unfortunate current limitation of astro starlight. If things change in the future this is the current limitations:
+
+- content folder MUST be under the astro website package(default src/content)
+- astro allows symlink but it MUST be the whole collection(e.g. `src/content/docs`)
+- starlight only way to put docs under a `docs/` path is to have another `docs/` folder under the collection one `src/content/docs` (resulting in `src/content/docs/docs`)
+
+If any of the issues above is improve we could potentially move the docs back here or reduce at least some nesting

packages/typespec-autorest-canonical/package.json

@@ -44,7 +44,7 @@
     "test:ci": "vitest run --coverage  --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/emitters/typespec-autorest-canonical/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/emitters/typespec-autorest-canonical/reference"
   },
   "files": [
     "lib/*.tsp",

packages/typespec-autorest/package.json

@@ -46,7 +46,7 @@
     "test:ci": "vitest run --coverage --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/emitters/typespec-autorest/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/emitters/typespec-autorest/reference"
   },
   "files": [
     "lib/*.tsp",

packages/typespec-azure-core/package.json

@@ -45,7 +45,7 @@
     "test:ci": "vitest run --coverage  --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/libraries/azure-core/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/libraries/azure-core/reference"
   },
   "files": [
     "lib/*.tsp",

packages/typespec-azure-portal-core/package.json

@@ -17,7 +17,7 @@
     "test:ci": "vitest run --coverage  --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/libraries/azure-portal-core/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/libraries/azure-portal-core/reference"
   },
   "keywords": [
     "Azure",

packages/typespec-azure-resource-manager/package.json

@@ -45,7 +45,7 @@
     "test:ci": "vitest run --coverage  --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/libraries/azure-resource-manager/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/libraries/azure-resource-manager/reference"
   },
   "files": [
     "lib/**/*.tsp",

packages/typespec-azure-rulesets/package.json

@@ -36,7 +36,7 @@
     "test:ci": "vitest run --coverage --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/emitters/typespec-azure-rulesets/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/emitters/typespec-azure-rulesets/reference"
   },
   "files": [
     "dist/**",

packages/typespec-client-generator-core/package.json

@@ -47,7 +47,7 @@
     "test:e2e": "vitest run --config ./vitest.config.e2e.ts",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/libraries/typespec-client-generator-core/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/libraries/typespec-client-generator-core/reference"
   },
   "files": [
     "lib/*.tsp",

packages/typespec-service-csharp/package.json

@@ -38,7 +38,7 @@
     "test:ci": "vitest run --coverage  --reporter=junit --reporter=default",
     "lint": "eslint .  --max-warnings=0",
     "lint:fix": "eslint . --fix ",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/emitters/typespec-service-csharp/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../website/src/content/docs/docs/emitters/typespec-service-csharp/reference"
   },
   "files": [
     "lib/*.tsp",

website/package.json

@@ -4,10 +4,9 @@
   "private": true,
   "version": "0.0.1",
   "scripts": {
-    "copy": "cp -r ../docs/. ./src/content/docs/docs",
     "dev": "astro dev",
     "start": "astro dev",
-    "build": "pnpm copy && tsx ./.scripts/build.ts",
+    "build": "tsx ./.scripts/build.ts",
     "build:web": "pnpm regen-all-packages-docs && astro check --minimumFailingSeverity warning && astro build",
     "preview": "astro preview",
     "regen-all-packages-docs": "pnpm -w --filter \"@azure-tools/typespec-azure-website...\" --filter \"!@typespec/monorepo\" --filter \"!@azure-tools/typespec-azure-monorepo\" run regen-docs",