renamed site to docs

Author: ndbroadbent

.cspell.json

@@ -24,6 +24,6 @@
   "dictionaries": [
     "project-words",
     "lockfile-words-root",
-    "lockfile-words-site"
+    "lockfile-words-docs"
   ]
 }

.github/workflows/deploy-site.yml .github/workflows/deploy-docs.yml.github/workflows/deploy-site.yml renamed to .github/workflows/deploy-docs.yml

@@ -50,40 +50,40 @@ jobs:
         with:
           node-version: '20'
           cache: 'pnpm'
-          cache-dependency-path: 'site/pnpm-lock.yaml'
+          cache-dependency-path: 'docs/pnpm-lock.yaml'
 
-      - name: Install site dependencies
+      - name: Install docs dependencies
         run: |
-          cd site && pnpm install --frozen-lockfile
+          cd docs && pnpm install --frozen-lockfile
 
       - name: Setup Pages
         uses: actions/configure-pages@v4
         with:
-          static_site_generator: next
+          static_docs_generator: next
 
       - name: Download coverage artifacts
         uses: dawidd6/action-download-artifact@v3 # cspell:ignore dawidd6
         with:
           workflow: test.yml
           workflow_conclusion: success
           name: coverage-ruby3.4-rails8.0
-          path: site/public/coverage/
+          path: docs/public/coverage/
 
       - name: Generate YARD documentation
         run: |
-          bundle exec yard doc --output-dir=site/public/yard
+          bundle exec yard doc --output-dir=docs/public/yard
 
       - name: Export TypeScript types
         run: |
           scripts/generate_structs.rb
 
       - name: Build with Next.js
-        run: cd site && pnpm run build
+        run: cd docs && pnpm run build
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ./site/out
+          path: ./docs/out
 
   deploy:
     environment:

.github/workflows/release.yml

@@ -235,7 +235,7 @@ jobs:
             exit 1
           fi
 
-      - name: Generate site exports (enums/structs/keys)
+      - name: Generate docs exports (enums/structs/keys)
         run: scripts/generate_structs.rb
 
       - name: Clone terraform-provider-logstruct repository

.github/workflows/test.yml

@@ -38,13 +38,13 @@ jobs:
           cache: pnpm
           cache-dependency-path: |
             pnpm-lock.yaml
-            site/pnpm-lock.yaml
+            docs/pnpm-lock.yaml
 
       - name: Install npm packages
         run: |
-          # Install root and site pnpm dependencies
+          # Install root and docs pnpm dependencies
           pnpm install --frozen-lockfile
-          cd site && pnpm install --frozen-lockfile && cd ..
+          cd docs && pnpm install --frozen-lockfile && cd ..
 
       - name: Generate CSpell dictionaries from package lockfiles
         run: |
@@ -89,7 +89,7 @@ jobs:
       - name: Sorbet (Typecheck)
         run: scripts/typecheck.sh
 
-  site:
+  docs:
     name: 'Next.js Site Tests'
     runs-on: ubuntu-22.04
     steps:
@@ -101,7 +101,7 @@ jobs:
           ruby-version: '.ruby-version'
           bundler-cache: true
 
-      - name: Setup Node.js (site)
+      - name: Setup Node.js (docs)
         uses: actions/setup-node@v4
         with:
           node-version: 20
@@ -111,27 +111,27 @@ jobs:
         with:
           version: latest
 
-      - name: Enable pnpm cache (site)
+      - name: Enable pnpm cache (docs)
         uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: pnpm
-          cache-dependency-path: site/pnpm-lock.yaml
+          cache-dependency-path: docs/pnpm-lock.yaml
 
-      - name: Install site dependencies
-        run: cd site && pnpm install --frozen-lockfile
+      - name: Install docs dependencies
+        run: cd docs && pnpm install --frozen-lockfile
 
       - name: Export TypeScript types from LogStruct
         run: |
           scripts/generate_structs.rb
 
       - name: TypeScript type checking
         run: |
-          cd site && pnpm exec tsc --noEmit
+          cd docs && pnpm exec tsc --noEmit
 
       - name: Run TypeScript tests
         run: |
-          cd site && pnpm test
+          cd docs && pnpm test
 
   pilot:
     name: 'Pilot Test: Ruby 3.4 / Rails 8.0'
@@ -173,7 +173,7 @@ jobs:
           retention-days: 5
           include-hidden-files: true
 
-      # Merges /coverage and /coverage_rails into /site/public/coverage/
+      # Merges /coverage and /coverage_rails into /docs/public/coverage/
       - name: Merge coverage reports
         run: scripts/merge_coverage.sh
 
@@ -187,7 +187,7 @@ jobs:
         with:
           name: coverage-ruby3.4-rails8.0
           path: |
-            site/public/coverage/
+            docs/public/coverage/
           retention-days: 5
 
   matrix:

.gitignore

@@ -16,7 +16,7 @@
 # Source code references
 /reference
 
-# Next.js site ignore rules are in ./site/.gitignore
+# Next.js docs ignore rules are in ./docs/.gitignore
 
 # CSpell generated wordlists (from package lockfiles)
 .cspell/generated-*.txt

.prettierignore

@@ -2,12 +2,12 @@
 sorbet/
 tasks/
 
-site/.next
-site/out
+docs/.next
+docs/out
 
-site/generated/
+docs/generated/
 
-site/public/coverage
-site/public/yard
+docs/public/coverage
+docs/public/yard
 
 pnpm-lock.yaml

.yardopts

@@ -4,7 +4,7 @@
 --markup-provider=redcarpet
 --readme=README.md
 --title=LogStruct API Documentation
---output-dir=site/public/api
+--output-dir=docs/public/api
 --plugin sorbet
 'lib/**/*.rb'
 - README.md

AGENTS.md

@@ -26,12 +26,12 @@
 - Debug a specific test: Add `debugger` statements (developer only)
 - Run Rails integration tests: `scripts/rails_tests.sh`
 - Merge coverage reports: `scripts/merge_coverage.sh`
-- Run Next.js TypeScript tests: `cd site && npm test`
+- Run Next.js TypeScript tests: `cd docs && npm test`
 
 ### Quality Commands
 
 - Ruby typecheck: `scripts/typecheck.sh`
-- Next.js typecheck: `cd site && pnpm exec tsc --noEmit`
+- Next.js typecheck: `cd docs && pnpm exec tsc --noEmit`
 - Lint Ruby: `bin/rubocop`
 - Format Ruby: `bin/rubocop -A`
 - Format JS/TS/JSON: `scripts/prettier.sh --write`

INTEGRATIONS.md

@@ -1,6 +1,6 @@
 **Purpose**
 
-- Document how to add a new first‑class integration to LogStruct so it’s consistent, type‑safe, well‑tested, and shows up automatically in the docs site with an auto‑generated example log.
+- Document how to add a new first‑class integration to LogStruct so it’s consistent, type‑safe, well‑tested, and shows up automatically in the docs docs with an auto‑generated example log.
 
 **High‑Level Flow**
 
@@ -9,7 +9,7 @@
 - Implement the integration under `lib/log_struct/integrations/…` to produce that log type.
 - Add the dev dependency for the third‑party gem and generate RBIs with Tapioca.
 - Add tests (unit + behavior) under `test/log_struct/integrations` and (if needed) `test/log_struct/log`.
-- Add a short entry in the docs metadata (`site/lib/integration-helpers.ts`). The Integrations page will render it automatically via `AllLogTypes`.
+- Add a short entry in the docs metadata (`docs/lib/integration-helpers.ts`). The Integrations page will render it automatically via `AllLogTypes`.
 - Run type export to update the docs’ TypeScript types.
 
 **Conventions**
@@ -99,7 +99,7 @@
 
 7. Docs
    - No custom sections in the Integrations page.
-   - The Integrations page lists all `AllLogTypes` with titles/descriptions from `site/lib/integration-helpers.ts`.
+   - The Integrations page lists all `AllLogTypes` with titles/descriptions from `docs/lib/integration-helpers.ts`.
    - Add an entry to `getLogTypeInfo` for your new log type (title, concise description, optional `configuration_code: 'integrations_configuration'`).
    - Run the type export to regenerate the docs’ TypeScript assets so example logs render:
      - `ruby scripts/generate_structs.rb`

README.md

@@ -44,7 +44,7 @@ $ gem install logstruct
 
 LogStruct is designed to be highly opinionated and work out of the box with minimal configuration.
 
-Please see the [documentation](https://logstruct.com/site/configuration/) for configuration options.
+Please see the [documentation](https://logstruct.com/docs/configuration/) for configuration options.
 
 ### Important Notes on Integration
 
@@ -83,7 +83,7 @@ In addition to the built‑in, strictly typed log structures (Request, Error, SQ
 - Fix your `source` to a constant (e.g., return the string `"payments"`), and restrict `event` with a `T::Enum` (e.g., `processed|failed|refunded`).
 - The `LogStruct.info` signature accepts either the internal `CommonFields` (for built‑ins) or your public custom type, so you keep type safety at the call site.
 
-See the docs page for a complete example: [Sorbet Types → Custom Typed Logs](https://logstruct.com/site/sorbet-types#custom-log-classes).
+See the docs page for a complete example: [Sorbet Types → Custom Typed Logs](https://logstruct.com/docs/sorbet-types#custom-log-classes).
 
 ## License