docs: generate ref docs from pipeline

.github/actions/setup/action.yml

@@ -0,0 +1,21 @@
+name: Setup
+description: Perform standard setup and install dependencies using pnpm.
+inputs:
+  node-version:
+    description: The version of Node.js to install
+    required: true
+    default: 18.17.0
+
+runs:
+  using: composite
+  steps:
+    - name: Install pnpm
+      uses: pnpm/action-setup@v2
+    - name: Install node
+      uses: actions/setup-node@v3
+      with:
+        cache: pnpm
+        node-version: ${{ inputs.node-version }}
+    - name: Install dependencies
+      shell: bash
+      run: pnpm install --ignore-scripts

.github/workflows/pages.yml

@@ -0,0 +1,51 @@
+name: Pages Flow
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        uses: ./.github/actions/setup
+      - run: pnpm docgen
+      - name: Build pages Jekyll
+        if: github.repository_owner == 'floydspace' && github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+      - name: Upload pages artifact
+        if: github.repository_owner == 'floydspace' && github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v2
+
+  deploy:
+    if: github.repository_owner == 'floydspace' && github.event_name == 'push' && github.ref == 'refs/heads/main'
+    name: Deploy
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    needs: build
+    permissions:
+      pages: write # To deploy to GitHub Pages
+      id-token: write # To verify the deployment originates from an appropriate source
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/pt.yml → .github/workflows/pr.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   build:
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:

.projenrc.ts

@@ -10,6 +10,7 @@ const project = new monorepo.MonorepoTsProject({
   name: name,
   description: "Effectful AWS",
   repository: `github:${repo}`,
+  homepage: `https://${org}.github.io/${name}`,
   authorEmail: "[email protected]",
   authorName: "Victor Korzunin",
   license: "MIT",
@@ -19,6 +20,10 @@ const project = new monorepo.MonorepoTsProject({
   devDeps: ["@types/jest"], // needed for vscode to not complain about jest types
 });
 
+project.addTask("docgen", {
+  exec: "pnpm exec nx run-many --target=docgen --output-style=stream --nx-bail && node scripts/docs.mjs",
+});
+
 new YamlFile(project, ".github/FUNDING.yml", { obj: { github: org } });
 
 new Changesets(project, {
@@ -124,5 +129,6 @@ new TypeScriptLibProject({
 });
 
 project.addGitIgnore(".direnv/"); // flake environment creates .direnv folder
+project.addGitIgnore("docs/"); // docs are generated
 
 project.synth();

.vscode/.gitignore

@@ -0,0 +1 @@
+settings.json

docs/_config.yml

@@ -0,0 +1,5 @@
+remote_theme: mikearnaldi/just-the-docs
+search_enabled: true
+aux_links:
+  "GitHub":
+    - "//github.com/floydspace/effect-aws"

docs/index.md

@@ -0,0 +1,9 @@
+---
+title: Introduction
+permalink: /
+nav_order: 1
+has_children: false
+has_toc: false
+---
+
+## Work In Progress

packages/client-api-gateway-management-api/src/ApiGatewayManagementApiClientInstance.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import { ApiGatewayManagementApiClient } from "@aws-sdk/client-apigatewaymanagementapi";
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";

packages/client-api-gateway-management-api/src/ApiGatewayManagementApiClientInstanceConfig.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import type { ApiGatewayManagementApiClientConfig } from "@aws-sdk/client-apigatewaymanagementapi";
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";

packages/client-api-gateway-management-api/src/ApiGatewayManagementApiService.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import {
   ApiGatewayManagementApiServiceException,
   DeleteConnectionCommand,
@@ -165,12 +168,14 @@ export const DefaultApiGatewayManagementApiServiceLayer =
 // -------------------- Danger Zone --------------------
 
 /**
+ * @since 0.1.0
  * @deprecated
  */
 export const BaseApiGatewayManagementApiServiceEffect =
   makeApiGatewayManagementApiService;
 
 /**
+ * @since 0.1.0
  * @deprecated
  */
 export const ApiGatewayManagementApiServiceEffect =
@@ -179,6 +184,7 @@ export const ApiGatewayManagementApiServiceEffect =
   );
 
 /**
+ * @since 0.1.0
  * @deprecated
  */
 export const DefaultApiGatewayManagementApiServiceEffect =

packages/client-dynamodb/src/DynamoDBClientInstance.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";

packages/client-dynamodb/src/DynamoDBClientInstanceConfig.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";

packages/client-dynamodb/src/DynamoDBService.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import {
   BatchExecuteStatementCommand,
   BatchExecuteStatementCommandInput,
@@ -1175,18 +1178,21 @@ export const DefaultDynamoDBServiceLayer = DynamoDBServiceLayer.pipe(
 // -------------------- Danger Zone --------------------
 
 /**
+ * @since 0.1.0
  * @deprecated
  */
 export const BaseDynamoDBServiceEffect = makeDynamoDBService;
 
 /**
+ * @since 0.1.0
  * @deprecated
  */
 export const DynamoDBServiceEffect = BaseDynamoDBServiceEffect.pipe(
   Effect.provide(DynamoDBClientInstanceLayer),
 );
 
 /**
+ * @since 0.1.0
  * @deprecated
  */
 export const DefaultDynamoDBServiceEffect = BaseDynamoDBServiceEffect.pipe(