Skip to content

docs(claude-md): expand directory structure and add CI/CD and Gotchas sections#25

Merged
marevol merged 1 commit intomasterfrom
docs/expand-claude-md-directory-structure
Mar 12, 2026
Merged

docs(claude-md): expand directory structure and add CI/CD and Gotchas sections#25
marevol merged 1 commit intomasterfrom
docs/expand-claude-md-directory-structure

Conversation

@marevol
Copy link
Collaborator

@marevol marevol commented Mar 12, 2026

Summary

Expands the CLAUDE.md documentation to provide a more complete and accurate reference for AI assistants working on this codebase.

Changes Made

  • Expanded the sax/ directory listing with all missing classes (HTMLSAXScanner, HTMLAttributesImpl, HTMLDocumentHandler, EncodingMap, HTMLQName, HTMLStringBuffer, HTMLAugmentations, XMLChar)
  • Added missing top-level classes to directory structure (HTMLEventInfo, ObjectFactory, SecuritySupport)
  • Added CI/CD section documenting GitHub Actions workflows (maven.yml, codeql-analysis.yml)
  • Added Gotchas section with important notes about formatter requirements, ObjectFactory registration, and HTMLSAXScanner hierarchy

Testing

Documentation-only change — no functional code modified.

Additional Notes

These additions help AI assistants avoid common mistakes (e.g., skipping formatter/license steps) and provide a complete picture of the codebase structure.

… sections

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@marevol marevol merged commit 67b5631 into master Mar 12, 2026
1 check passed
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