Skip to content

refactor: decouple spec identifiers from dev-docs.alchemy.com URL#1103

Open
blakecduncan wants to merge 3 commits intomainfrom
blake/dx-2307-decouple-spec-identifiers
Open

refactor: decouple spec identifiers from dev-docs.alchemy.com URL#1103
blakecduncan wants to merge 3 commits intomainfrom
blake/dx-2307-decouple-spec-identifiers

Conversation

@blakecduncan
Copy link
Contributor

Summary

  • Removes DEV_DOCS_BASE constant — spec identifiers are now relative paths (e.g. chains/eth.json) instead of full URLs
  • Renames specUrlspecId across content indexer: apiSpecs.ts, upload-specs.ts, pathIndex types, content-cache, preview-specs uploader, visitor/processor files
  • Renames getSpecTypeFromUrlgetSpecType
  • Updates all associated tests and README

Relates to DX-2307. Companion PR in docs-site repo (same branch name).

Deploy notes

  • Merge docs-site PR first for backwards compat
  • First CI run after merging this PR will re-upload all specs (hash key mismatch between old URL-format keys and new relative-path keys is expected)
  • Optional: clean up orphaned old-format Redis keys after both are deployed

Test plan

  • pnpm tsc --noEmit passes (pre-existing errors in unrelated files only)
  • All changes are mechanical renames verified by TypeScript compiler
  • CI tests pass after pnpm install

🤖 Generated with Claude Code

Rename specUrl → specId and remove DEV_DOCS_BASE constant across the
content indexer. Spec identifiers are now relative paths (e.g.
"chains/eth.json") instead of full URLs. This affects: apiSpecs.ts,
upload-specs.ts, pathIndex types, content-cache, preview-specs uploader,
visitor/processor files, and all associated tests.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@blakecduncan blakecduncan requested a review from a team as a code owner March 5, 2026 18:16
blakecduncan and others added 2 commits March 5, 2026 13:20
Switch the GHA workflow from deprecated specUrls to specIds in the
revalidation API request payload.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Mar 5, 2026, 6:30 PM

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

🔍 Link Check

Status: ⏭️ Skipped (no content changes)

Summary

No summary found.

No markdown content files changed in this PR.

View workflow run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant