Skip to content

refactor(terminology): replace user-facing "blog" → "post" across docs and packages#28

Open
haroonwaves wants to merge 2 commits intomainfrom
codex/replace-all-blog-references-with-post
Open

refactor(terminology): replace user-facing "blog" → "post" across docs and packages#28
haroonwaves wants to merge 2 commits intomainfrom
codex/replace-all-blog-references-with-post

Conversation

@haroonwaves
Copy link
Owner

Motivation

  • Standardize user-facing terminology from "blog" to "post" across docs and component APIs to better reflect wording while keeping project/package names intact.
  • Ensure code and documentation examples remain consistent so consumers use Post* types and components when integrating the library.

Description

  • Replaced user-facing strings and docs (app/content/*, README.md, etc.) from "blog" to "post" and updated examples to use post paths and config keys like postSubdirectory.
  • Renamed core types and APIs: BlogMetaPostMeta, BlogPost, BlogConfigPostConfig, extractBlogMetaextractPostMeta, extractBlogextractPost, getAllBlogsMetagetAllPostsMeta, and getBloggetPost in packages/blog-kit-core.
  • Renamed React package components and hook files/exports to Post* (BlogRendererPostRenderer, BlogCardPostCard, BlogListPostList, BlogPlaceholderPostPlaceholder, useBlogsusePosts) and updated packages/blog-kit-react/src/index.ts exports accordingly.
  • Adjusted app usage to remain compatible (added local aliases where needed and updated blogSubdirectoryblogSubdirectory/postSubdirectory usage in calls) and fixed related type errors so the monorepo type-checks cleanly; branding (blog-kit, package names) was intentionally preserved.

Testing

  • Ran pnpm type-check (workspace) and it completed successfully with no TypeScript errors.
  • Ran pnpm format:check and Prettier reported all matched files use the configured code style.
  • Both automated checks passed after the refactor.

Codex Task

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 5, 2026

Deploying blog-kit with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2e8f8c2
Status: ✅  Deploy successful!
Preview URL: https://f208a947.blog-kit.pages.dev
Branch Preview URL: https://codex-replace-all-blog-refer.blog-kit.pages.dev

View logs

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e0f312a1f4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +1 to +2
import { getAllBlogsMeta as getAllPostsMeta, getBlog as getPost } from '@haroonwaves/blog-kit-core';
import { BlogRenderer as PostRenderer } from '@haroonwaves/blog-kit-react';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Import renamed Post APIs directly in docs pages

This file still imports getAllBlogsMeta, getBlog, and BlogRenderer (aliased to Post names), but the same commit removes those Blog-prefixed exports from packages/blog-kit-core/src/parser.ts and packages/blog-kit-react/src/index.ts; as soon as the app resolves to the updated package version (the dependency ranges are caret-based), these imports become missing exports and the docs build fails. Switching these imports to getAllPostsMeta, getPost, and PostRenderer avoids that version-skew breakage.

Useful? React with 👍 / 👎.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant