Skip to content

Commit dacefdb

Browse files
rexkirshnerclaude
andcommitted
Update documentation for published npm packages
- Updated all package references from @podcast-framework/* to @rejected-media/podcast-framework-* - Updated 33 documentation files across all sections: - Getting started guides - Component documentation - API references - Sanity setup and configuration - Deployment guides - Examples and customization - Updated node_modules path references - Changed 220+ package name references Documentation now reflects published npm packages. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 261be10 commit dacefdb

33 files changed

+219
-219
lines changed

src/content/docs/api/hosting-adapter.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import {
1717
getClientIP,
1818
getPlatformInfo,
1919
logError
20-
} from '@podcast-framework/core';
20+
} from '@rejected-media/podcast-framework-core';
2121
```
2222

2323
## Why Use the Hosting Adapter?
@@ -36,7 +36,7 @@ const apiKey = context.locals.runtime.env.API_KEY; // Cloudflare
3636

3737
```typescript
3838
// ✅ Works everywhere
39-
import { getEnv } from '@podcast-framework/core';
39+
import { getEnv } from '@rejected-media/podcast-framework-core';
4040

4141
const apiKey = getEnv('API_KEY', context);
4242
```
@@ -67,7 +67,7 @@ type HostingPlatform = 'cloudflare' | 'netlify' | 'vercel' | 'local' | 'unknown'
6767
6868
**Examples:**
6969
```typescript
70-
import { detectPlatform } from '@podcast-framework/core';
70+
import { detectPlatform } from '@rejected-media/podcast-framework-core';
7171

7272
const platform = detectPlatform();
7373
// → "cloudflare" | "netlify" | "vercel" | "local" | "unknown"
@@ -81,7 +81,7 @@ if (platform === 'cloudflare') {
8181
```typescript
8282
// src/pages/api/example.ts
8383
import type { APIRoute } from 'astro';
84-
import { detectPlatform } from '@podcast-framework/core';
84+
import { detectPlatform } from '@rejected-media/podcast-framework-core';
8585

8686
export const GET: APIRoute = async (context) => {
8787
const platform = detectPlatform(context);
@@ -115,7 +115,7 @@ function getEnv(
115115

116116
**Examples:**
117117
```typescript
118-
import { getEnv } from '@podcast-framework/core';
118+
import { getEnv } from '@rejected-media/podcast-framework-core';
119119
120120
// With fallback
121121
const apiKey = getEnv('API_KEY', context, 'default-key');
@@ -131,7 +131,7 @@ const required = getEnv('REQUIRED_VAR', context);
131131
```typescript
132132
// src/pages/api/newsletter-subscribe.ts
133133
import type { APIRoute } from 'astro';
134-
import { getEnv } from '@podcast-framework/core';
134+
import { getEnv } from '@rejected-media/podcast-framework-core';
135135
136136
export const POST: APIRoute = async (context) => {
137137
const apiKey = getEnv('CONVERTKIT_API_KEY', context);
@@ -167,7 +167,7 @@ function getRequiredEnv(
167167

168168
**Examples:**
169169
```typescript
170-
import { getRequiredEnv } from '@podcast-framework/core';
170+
import { getRequiredEnv } from '@rejected-media/podcast-framework-core';
171171
172172
// Get multiple variables (throws if missing)
173173
const { API_KEY, API_SECRET, PROJECT_ID } = getRequiredEnv(
@@ -197,7 +197,7 @@ try {
197197
```typescript
198198
// src/pages/api/contribute.ts
199199
import type { APIRoute } from 'astro';
200-
import { getRequiredEnv, ContributionService } from '@podcast-framework/core';
200+
import { getRequiredEnv, ContributionService } from '@rejected-media/podcast-framework-core';
201201
202202
export const POST: APIRoute = async (context) => {
203203
try {
@@ -241,7 +241,7 @@ function getClientIP(context: APIContext): string
241241

242242
**Examples:**
243243
```typescript
244-
import { getClientIP } from '@podcast-framework/core';
244+
import { getClientIP } from '@rejected-media/podcast-framework-core';
245245
246246
export const POST: APIRoute = async (context) => {
247247
const clientIP = getClientIP(context);
@@ -262,7 +262,7 @@ export const POST: APIRoute = async (context) => {
262262

263263
**Usage - Rate Limiting:**
264264
```typescript
265-
import { getClientIP } from '@podcast-framework/core';
265+
import { getClientIP } from '@rejected-media/podcast-framework-core';
266266
267267
const rateLimits = new Map<string, number>();
268268
@@ -301,7 +301,7 @@ function getPlatformInfo(context?: APIContext): {
301301

302302
**Examples:**
303303
```typescript
304-
import { getPlatformInfo } from '@podcast-framework/core';
304+
import { getPlatformInfo } from '@rejected-media/podcast-framework-core';
305305
306306
const info = getPlatformInfo(context);
307307
@@ -356,7 +356,7 @@ function logError(
356356

357357
**Examples:**
358358
```typescript
359-
import { logError } from '@podcast-framework/core';
359+
import { logError } from '@rejected-media/podcast-framework-core';
360360
361361
try {
362362
await riskyOperation();
@@ -456,7 +456,7 @@ import {
456456
getClientIP,
457457
getPlatformInfo,
458458
logError
459-
} from '@podcast-framework/core';
459+
} from '@rejected-media/podcast-framework-core';
460460
461461
export const POST: APIRoute = async (context) => {
462462
try {
@@ -527,7 +527,7 @@ Estimated: 2-4 hours
527527
### Conditional Code
528528
529529
```typescript
530-
import { detectPlatform } from '@podcast-framework/core';
530+
import { detectPlatform } from '@rejected-media/podcast-framework-core';
531531
532532
export const POST: APIRoute = async (context) => {
533533
const platform = detectPlatform(context);
@@ -547,7 +547,7 @@ export const POST: APIRoute = async (context) => {
547547
### Environment-Specific Behavior
548548

549549
```typescript
550-
import { getPlatformInfo } from '@podcast-framework/core';
550+
import { getPlatformInfo } from '@rejected-media/podcast-framework-core';
551551

552552
export const POST: APIRoute = async (context) => {
553553
const { isDevelopment, isProduction } = getPlatformInfo(context);
@@ -570,7 +570,7 @@ export const POST: APIRoute = async (context) => {
570570
### Basic Logging
571571

572572
```typescript
573-
import { logError } from '@podcast-framework/core';
573+
import { logError } from '@rejected-media/podcast-framework-core';
574574

575575
try {
576576
await riskyOperation();
@@ -617,7 +617,7 @@ logError(error, {
617617
If Sentry is initialized, errors automatically go to Sentry:
618618

619619
```typescript
620-
import { initSentry, logError } from '@podcast-framework/core';
620+
import { initSentry, logError } from '@rejected-media/podcast-framework-core';
621621

622622
// Initialize Sentry once
623623
initSentry({
@@ -705,7 +705,7 @@ export const POST: APIRoute = async (context) => {
705705

706706
// ❌ Don't use in client-side code
707707
<script>
708-
import { getEnv } from '@podcast-framework/core';
708+
import { getEnv } from '@rejected-media/podcast-framework-core';
709709
const apiKey = getEnv('API_KEY'); // Won't work, no context
710710
</script>
711711
```

src/content/docs/api/sanity-helpers.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import {
1717
getGuest,
1818
getPodcast,
1919
getFeatured
20-
} from '@podcast-framework/core';
20+
} from '@rejected-media/podcast-framework-core';
2121
```
2222

2323
## Why Use Helpers?
@@ -26,7 +26,7 @@ import {
2626

2727
```astro
2828
---
29-
import { createSanityClient, getAllEpisodes } from '@podcast-framework/core';
29+
import { createSanityClient, getAllEpisodes } from '@rejected-media/podcast-framework-core';
3030
3131
const sanityClient = createSanityClient({
3232
projectId: import.meta.env.PUBLIC_SANITY_PROJECT_ID,
@@ -43,7 +43,7 @@ const episodes = await getAllEpisodes(sanityClient);
4343

4444
```astro
4545
---
46-
import { getEpisodes } from '@podcast-framework/core';
46+
import { getEpisodes } from '@rejected-media/podcast-framework-core';
4747
4848
const episodes = await getEpisodes();
4949
---
@@ -72,7 +72,7 @@ function getEpisodes(options?: {
7272
**Examples:**
7373
```astro
7474
---
75-
import { getEpisodes } from '@podcast-framework/core';
75+
import { getEpisodes } from '@rejected-media/podcast-framework-core';
7676
7777
// Get all episodes (newest first)
7878
const episodes = await getEpisodes();
@@ -130,7 +130,7 @@ function getEpisode(slug: string): Promise<Episode | null>
130130
**Examples:**
131131
```astro
132132
---
133-
import { getEpisode } from '@podcast-framework/core';
133+
import { getEpisode } from '@rejected-media/podcast-framework-core';
134134
135135
const episode = await getEpisode('the-future-of-ethereum');
136136
@@ -168,7 +168,7 @@ function getGuests(): Promise<Guest[]>
168168
**Examples:**
169169
```astro
170170
---
171-
import { getGuests } from '@podcast-framework/core';
171+
import { getGuests } from '@rejected-media/podcast-framework-core';
172172
173173
const guests = await getGuests();
174174
---
@@ -214,7 +214,7 @@ function getGuest(slug: string): Promise<Guest | null>
214214
**Examples:**
215215
```astro
216216
---
217-
import { getGuest } from '@podcast-framework/core';
217+
import { getGuest } from '@rejected-media/podcast-framework-core';
218218
219219
const guest = await getGuest('vitalik-buterin');
220220
@@ -260,7 +260,7 @@ function getPodcast(): Promise<PodcastInfo | undefined>
260260
**Examples:**
261261
```astro
262262
---
263-
import { getPodcast } from '@podcast-framework/core';
263+
import { getPodcast } from '@rejected-media/podcast-framework-core';
264264
265265
const podcast = await getPodcast();
266266
const siteName = podcast?.name || 'Podcast';
@@ -307,7 +307,7 @@ function getFeatured(limit?: number): Promise<Episode[]>
307307
**Examples:**
308308
```astro
309309
---
310-
import { getFeatured } from '@podcast-framework/core';
310+
import { getFeatured } from '@rejected-media/podcast-framework-core';
311311
312312
// Get all featured episodes
313313
const featured = await getFeatured();
@@ -392,10 +392,10 @@ import {
392392
getPodcast,
393393
getEpisodes,
394394
getFeatured
395-
} from '@podcast-framework/core';
395+
} from '@rejected-media/podcast-framework-core';
396396
397-
import BaseLayout from '@podcast-framework/core/layouts/BaseLayout.astro';
398-
import FeaturedEpisodesCarousel from '@podcast-framework/core/components/FeaturedEpisodesCarousel.astro';
397+
import BaseLayout from '@rejected-media/podcast-framework-core/layouts/BaseLayout.astro';
398+
import FeaturedEpisodesCarousel from '@rejected-media/podcast-framework-core/components/FeaturedEpisodesCarousel.astro';
399399
400400
// Fetch all data (cached automatically)
401401
const podcast = await getPodcast();
@@ -641,7 +641,7 @@ For advanced queries, use low-level functions:
641641
import {
642642
createSanityClient,
643643
getAllEpisodes
644-
} from '@podcast-framework/core';
644+
} from '@rejected-media/podcast-framework-core';
645645

646646
const client = createSanityClient({
647647
projectId: import.meta.env.PUBLIC_SANITY_PROJECT_ID,

src/content/docs/api/server-services.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Server Services provide pure business logic for backend functionality like commu
1313
import {
1414
ContributionService,
1515
NewsletterService
16-
} from '@podcast-framework/core';
16+
} from '@rejected-media/podcast-framework-core';
1717

1818
import type {
1919
ContributionRequest,
2020
ContributionResult,
2121
NewsletterSubscribeRequest,
2222
NewsletterSubscribeResult
23-
} from '@podcast-framework/core';
23+
} from '@rejected-media/podcast-framework-core';
2424
```
2525

2626
## Why Use Services?
@@ -79,8 +79,8 @@ Handle community contributions (episode ideas, guest recommendations, questions,
7979
### Configuration
8080

8181
```typescript
82-
import { ContributionService } from '@podcast-framework/core';
83-
import type { ContributionServiceConfig } from '@podcast-framework/core';
82+
import { ContributionService } from '@rejected-media/podcast-framework-core';
83+
import type { ContributionServiceConfig } from '@rejected-media/podcast-framework-core';
8484

8585
const config: ContributionServiceConfig = {
8686
sanityProjectId: 'abc123',
@@ -152,7 +152,7 @@ interface ContributionResult {
152152
```typescript
153153
// src/pages/api/contribute.ts
154154
import type { APIRoute } from 'astro';
155-
import { ContributionService, getRequiredEnv } from '@podcast-framework/core';
155+
import { ContributionService, getRequiredEnv } from '@rejected-media/podcast-framework-core';
156156

157157
export const POST: APIRoute = async (context) => {
158158
const env = getRequiredEnv([
@@ -210,8 +210,8 @@ Handle newsletter subscriptions via ConvertKit.
210210
### Configuration
211211

212212
```typescript
213-
import { NewsletterService } from '@podcast-framework/core';
214-
import type { NewsletterServiceConfig } from '@podcast-framework/core';
213+
import { NewsletterService } from '@rejected-media/podcast-framework-core';
214+
import type { NewsletterServiceConfig } from '@rejected-media/podcast-framework-core';
215215

216216
const config: NewsletterServiceConfig = {
217217
sanityProjectId: 'abc123',
@@ -256,7 +256,7 @@ interface NewsletterSubscribeResult {
256256
```typescript
257257
// src/pages/api/newsletter-subscribe.ts
258258
import type { APIRoute } from 'astro';
259-
import { NewsletterService, getRequiredEnv } from '@podcast-framework/core';
259+
import { NewsletterService, getRequiredEnv } from '@rejected-media/podcast-framework-core';
260260

261261
export const POST: APIRoute = async (context) => {
262262
const env = getRequiredEnv([
@@ -316,7 +316,7 @@ import {
316316
getRequiredEnv,
317317
getClientIP,
318318
logError
319-
} from '@podcast-framework/core';
319+
} from '@rejected-media/podcast-framework-core';
320320

321321
export const POST: APIRoute = async (context) => {
322322
try {
@@ -386,7 +386,7 @@ import {
386386
getRequiredEnv,
387387
getClientIP,
388388
logError
389-
} from '@podcast-framework/core';
389+
} from '@rejected-media/podcast-framework-core';
390390

391391
export const POST: APIRoute = async (context) => {
392392
try {
@@ -434,7 +434,7 @@ Services are pure business logic and easy to test:
434434

435435
```typescript
436436
import { describe, test, expect } from 'vitest';
437-
import { NewsletterService } from '@podcast-framework/core';
437+
import { NewsletterService } from '@rejected-media/podcast-framework-core';
438438

439439
describe('NewsletterService', () => {
440440
test('validates email format', () => {
@@ -504,7 +504,7 @@ Services return structured error responses:
504504

505505
```typescript
506506
// src/lib/custom-contribution-service.ts
507-
import { ContributionService } from '@podcast-framework/core';
507+
import { ContributionService } from '@rejected-media/podcast-framework-core';
508508

509509
export class CustomContributionService extends ContributionService {
510510
async submitContribution(request: ContributionRequest) {

0 commit comments

Comments
 (0)