Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b48726f
feat: migrate content-indexer to docs repo
dslovinsky Jan 8, 2026
7f20c5f
feat: build out separate functionality for content-indexer params
dslovinsky Jan 9, 2026
5548457
chore: switch to type: module
dslovinsky Jan 9, 2026
8a1dd65
feat: switch to tsx from ts-node
dslovinsky Jan 9, 2026
671d213
feat: config env vars in content-indexer scripts
dslovinsky Jan 9, 2026
1be65ef
fix: content-indexer bugs
dslovinsky Jan 9, 2026
2e186f0
fix: content-indexer bugs re:sdk nav tree merge
dslovinsky Jan 9, 2026
1c5cfe4
feat: port over changelog functionality to content-indexer
dslovinsky Jan 9, 2026
93f195b
feat: remove markdown syntax from algolia content field
dslovinsky Jan 9, 2026
2101a10
refactor: reduce duplicate code
dslovinsky Jan 9, 2026
2c31f11
build: configure tests and test coverage
dslovinsky Jan 9, 2026
d89c5e2
docs: update content-indexer readme
dslovinsky Jan 9, 2026
98fa73b
fix: TS issue
dslovinsky Jan 9, 2026
dbad862
feat: only update algolia in prod & add TTL to preview redis entries
dslovinsky Jan 9, 2026
25525ad
build: remove unnecessary chokidar dep
dslovinsky Jan 9, 2026
3e45c40
chore: remove Algolia base index name env var
dslovinsky Jan 9, 2026
06d4544
chore: remove unused redis env vars
dslovinsky Jan 9, 2026
7ef0eaf
feat: create github actions to run indexers automatically
dslovinsky Jan 9, 2026
8bef3b7
Merge branch 'main' of github.com:alchemyplatform/docs into ds/conten…
dslovinsky Jan 9, 2026
101ac90
chore: remove coverage report from git
dslovinsky Jan 9, 2026
f4f0331
chore: add coverage/ to gitignore
dslovinsky Jan 9, 2026
470017b
chore: remove repo dispatch trigger for GH pages deploy
dslovinsky Jan 9, 2026
7336a4a
Merge branch 'main' of github.com:alchemyplatform/docs into ds/conten…
dslovinsky Jan 13, 2026
5f21596
feat: add description field to algolia records
dslovinsky Jan 13, 2026
74b2b39
fix: add missing algolia descriptions for section pages
dslovinsky Jan 13, 2026
b5b4d96
chore: remove unused func
dslovinsky Jan 13, 2026
b085a0c
fix: use paths instead of title/breadcrumb for algolia objectID seed
dslovinsky Jan 13, 2026
42e4aae
fix: docs homepage bug caused by .js imports
dslovinsky Jan 13, 2026
fc4e017
chore: use .ts imports rather than .js where possible
dslovinsky Jan 13, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Content Indexer Environment Variables
# Copy this file to .env.local and fill in your actual values

# ============================================================================
# GitHub API (Required for SDK indexer and production mode)
# ============================================================================
# Get a token at: https://github.com/settings/tokens
# Permissions needed: public_repo (read access to public repositories)
GH_TOKEN=your_github_token_here

# ============================================================================
# Redis / Upstash KV (Required for all indexers)
# ============================================================================
# Used to store path indices and navigation trees
# Get these from your Upstash dashboard: https://console.upstash.com/
KV_REST_API_URL=your_kv_url_here
KV_REST_API_TOKEN=your_kv_token_here

# ============================================================================
# Algolia (Required for all indexers)
# ============================================================================
# Used for search indexing
# Get these from your Algolia dashboard: https://www.algolia.com/
ALGOLIA_APP_ID=your_app_id_here
ALGOLIA_ADMIN_API_KEY=your_admin_api_key_here

2 changes: 0 additions & 2 deletions .github/workflows/gh-pages-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ on:
- main
types:
- completed
repository_dispatch:
types: [trigger-gh-pages-deploy]
concurrency:
group: "pages"
cancel-in-progress: false
Expand Down
40 changes: 40 additions & 0 deletions .github/workflows/index-changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Index Changelog

on:
push:
branches:
- main
paths:
- "fern/changelog/**"

jobs:
index-changelog:
name: Index Changelog
runs-on: ubuntu-latest
# Only run when files are added or removed, not modified
if: |
github.event.head_commit &&
(
github.event.head_commit.added[0] != null ||
github.event.head_commit.removed[0] != null
) &&
(
contains(join(github.event.head_commit.added, ','), 'fern/changelog/') ||
contains(join(github.event.head_commit.removed, ','), 'fern/changelog/')
)
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup pnpm
uses: ./.github/actions/setup-pnpm

- name: Run changelog indexer
run: pnpm index:changelog
env:
KV_REST_API_TOKEN: ${{ secrets.KV_REST_API_TOKEN }}
KV_REST_API_URL: ${{ secrets.KV_REST_API_URL }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_ADMIN_API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }}
30 changes: 30 additions & 0 deletions .github/workflows/index-main-content.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Index Main Content

on:
push:
branches:
- main
paths:
- "fern/docs.yml"

jobs:
index-main:
name: Index Main Content
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup pnpm
uses: ./.github/actions/setup-pnpm

- name: Run main content indexer
run: pnpm index:main
env:
KV_REST_API_TOKEN: ${{ secrets.KV_REST_API_TOKEN }}
KV_REST_API_URL: ${{ secrets.KV_REST_API_URL }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_ADMIN_API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
30 changes: 30 additions & 0 deletions .github/workflows/index-sdk-references.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Index SDK References

on:
repository_dispatch:
types:
- index-sdk-references

jobs:
index-sdk:
name: Index SDK References
runs-on: ubuntu-latest
# Only run if the dispatch came from the aa-sdk repository
if: github.event.client_payload.source == 'alchemyplatform/aa-sdk'
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup pnpm
uses: ./.github/actions/setup-pnpm

- name: Run SDK indexer
run: pnpm index:sdk
env:
KV_REST_API_TOKEN: ${{ secrets.KV_REST_API_TOKEN }}
KV_REST_API_URL: ${{ secrets.KV_REST_API_URL }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_ADMIN_API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ node_modules/

# dotenv environment variables file
.env*
!.env.example

# misc
.DS_Store
Expand All @@ -35,3 +36,5 @@ fern/api-specs/
# local files
*.local

# vitests
coverage/
1 change: 1 addition & 0 deletions eslint.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ const tslintConfigs = tseslint.config({
},
],
"@typescript-eslint/consistent-type-imports": "error",
"@typescript-eslint/no-non-null-assertion": "error",
},
}) as ConfigWithExtends[];

Expand Down
Loading
Loading