Skip to content

Conversation

@sdirix
Copy link
Member

@sdirix sdirix commented Feb 5, 2026

Summary

This PR adds comprehensive documentation for the JSON Forms website project, including detailed architecture information and guidelines for AI assistants working on the codebase.

Changes

  • .prompts/project-info.prompttemplate: Added detailed project architecture documentation covering:

    • Technology stack (Docusaurus 3.x, React 18, Material-UI)
    • Complete directory structure with descriptions
    • Content organization (docs, examples, news, community, FAQ)
    • Key components and their purposes (Demo component, custom renderers, plugins)
    • Navigation structure and configuration files
    • Styling approach and theme variables
    • Version management and external integrations
  • CLAUDE.md: Added AI assistant guidelines including:

    • Project context and reference to detailed architecture docs
    • Development commands (install, start, build, serve, clear)
    • Critical requirement to build and test all changes before completion
    • Content and component development guidelines
    • Best practices for working with the Docusaurus-based site

Purpose

These documentation files serve as reference materials for:

  • Understanding the project structure and architecture
  • Onboarding new contributors
  • Providing context for AI assistants to make informed changes
  • Ensuring consistent development practices and quality standards

The guidelines emphasize the importance of building and testing changes locally before considering work complete, which helps maintain site stability and prevents deployment issues.

https://claude.ai/code/session_01BGdZQB16MNXpvqnSPESTfk

sdirix and others added 5 commits February 5, 2026 09:06
- Create .prompts/project-info.prompttemplate with repository architecture
- Create CLAUDE.md with development guidelines and build instructions
- Include guidance to always build and test changes

Co-authored-by: Claude Code / Opus <noreply@anthropic.com>
Co-authored-by: Claude Code / Opus <noreply@anthropic.com>
Co-authored-by: Claude Code / Opus <noreply@anthropic.com>
Co-authored-by: Claude Code / Opus <noreply@anthropic.com>
- CLAUDE.md now contains only link to project-info and dev commands
- project-info.prompttemplate contains project description, architecture,
  patterns, and guidelines

Co-authored-by: Claude Code / Opus <noreply@anthropic.com>
@sdirix sdirix marked this pull request as ready for review February 5, 2026 10:41
@sdirix sdirix requested a review from lucas-koehler February 5, 2026 10:41
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