Skip to content
/ devmdx Public template

docs: add CLAUDE.md with comprehensive codebase documentation#113

Merged
praveentcom merged 1 commit intomainfrom
claude/add-claude-documentation-u7sIE
Feb 21, 2026
Merged

docs: add CLAUDE.md with comprehensive codebase documentation#113
praveentcom merged 1 commit intomainfrom
claude/add-claude-documentation-u7sIE

Conversation

@praveentcom
Copy link
Owner

Provides AI assistants with project structure, tech stack, commands,
architecture patterns, code conventions, and common task guides.

https://claude.ai/code/session_018DcChR2JGyvPSZKuHZ5ecv

Provides AI assistants with project structure, tech stack, commands,
architecture patterns, code conventions, and common task guides.

https://claude.ai/code/session_018DcChR2JGyvPSZKuHZ5ecv
Copilot AI review requested due to automatic review settings February 21, 2026 02:58
@vercel
Copy link

vercel bot commented Feb 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
devmdx Error Error Feb 21, 2026 2:58am

@praveentcom praveentcom merged commit c980f4c into main Feb 21, 2026
4 of 7 checks passed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for AI assistants working with the DevMDX codebase. The CLAUDE.md file provides detailed information about the project's tech stack, architecture, conventions, and common tasks to help AI tools better understand and work with the codebase.

Changes:

  • Added CLAUDE.md with complete project documentation including tech stack, commands, project structure, architecture patterns, code conventions, and common tasks
  • Documented all path aliases, environment variables, routing patterns, and component organization
  • Included security practices and configuration details

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


### Component Organization

- **UI primitives** (`components/ui/`): shadcn/ui components. These are auto-generated — do not manually modify.
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

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

The statement that "UI primitives (components/ui/): shadcn/ui components. These are auto-generated — do not manually modify" is inaccurate. While many components in this directory are indeed shadcn/ui components, several are custom components including markdown.tsx (558 lines), code-block.tsx (374 lines), structured-data.tsx, theme-switcher.tsx, prefetch-link.tsx, empty-state.tsx, and spinner.tsx. This statement should be revised to clarify that the directory contains both auto-generated shadcn/ui components and custom UI components.

Suggested change
- **UI primitives** (`components/ui/`): shadcn/ui components. These are auto-generated — do not manually modify.
- **UI primitives** (`components/ui/`): shadcn/ui-based components and shared UI primitives. Many of these are derived from shadcn/ui generators/templates and should generally be updated via those sources rather than heavily modified in place, but this directory also contains custom components (e.g. `markdown.tsx`, `code-block.tsx`, `structured-data.tsx`, `theme-switcher.tsx`, `prefetch-link.tsx`, `empty-state.tsx`, `spinner.tsx`) that are intended to be edited as needed.

Copilot uses AI. Check for mistakes.
- Strict mode enabled
- Use Zod schemas for all content frontmatter validation
- Types exported alongside their schemas from `src/types/`
- Prefer `type` over `interface` for data shapes (project convention)
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

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

The statement "Prefer type over interface for data shapes (project convention)" is not accurate. The codebase actually uses both type and interface with a specific pattern: type is used for Zod-inferred types and content models (articles, projects, community, work, education), while interface is used for configuration objects (ConfigData, ConfigAnalyticsData, ConfigSeoData, Profile, SocialLinks, etc.). The convention should be clarified to reflect this nuanced pattern rather than suggesting a blanket preference for type.

Suggested change
- Prefer `type` over `interface` for data shapes (project convention)
- Use `type` for Zod-inferred types and content models (articles, projects, community, work, education), and use `interface` for configuration objects (e.g., `ConfigData`, `ConfigAnalyticsData`, `ConfigSeoData`, `Profile`, `SocialLinks`).

Copilot uses AI. Check for mistakes.
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.

3 participants