Add project documentation and AI assistant guidelines#318
Merged
Conversation
- 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>
Contributor
lucas-koehler
left a comment
lucas-koehler
left a comment
There was a problem hiding this comment.
Hi @sdirix , generally this looks good to me :) With Theia AI becoming more agentic, is it still recommended to keep the development commands out of the project info?
Member
Author
|
Do you mean the guidelines? For CLAUDE I like to list the commands to execute as otherwise it likes to not check and execute something |
Contributor
|
@sdirix I meant, should the content of |
Member
Author
|
Yes exactly, personally I use the tasks execution for this in Theia IDE while I am usually on the commandline for Claude Code |
lucas-koehler
approved these changes
Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:CLAUDE.md: Added AI assistant guidelines including:Purpose
These documentation files serve as reference materials for:
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