Skip to content

docs: update Java documentation to match actual implementation#1967

Open
mashraf-222 wants to merge 1 commit intomainfrom
docs/update-java-documentation
Open

docs: update Java documentation to match actual implementation#1967
mashraf-222 wants to merge 1 commit intomainfrom
docs/update-java-documentation

Conversation

@mashraf-222
Copy link
Copy Markdown
Contributor

Summary

  • Fixed configuration/java.mdx: Claimed config is in codeflash.toml (which doesn't exist). Rewrote to document actual storage: pom.xml properties (Maven) / gradle.properties (Gradle) via BuildConfigStrategy
  • Fixed java-installation.mdx: Step 3 showed advanced tracer as "first optimization" — replaced with simpler --file --function approach. Fixed Step 2 description of what codeflash init does
  • Fixed architecture.md: Said "Java planned" when Java is fully implemented with 30+ files. Added java/ directory tree, entry points, and JavaSupport to protocol description
  • Fixed index.mdx: Added Java to supported languages list, Get Started cards, and Configuration Reference cards
  • Fixed one-function.mdx: Added Java tab alongside Python/JS/TS
  • Fixed codeflash-all.mdx: Added Java to supported languages list
  • Fixed usage-guide.mdx: Replaced nonexistent codeflash.toml reference with pom.xml/gradle.properties

Test plan

  • Verify Mintlify docs build successfully with updated .mdx files
  • Confirm all internal doc links resolve correctly (especially Java config and installation pages)
  • Review configuration/java.mdx against build_config_strategy.py key mapping for accuracy

🤖 Generated with Claude Code

Java docs incorrectly referenced codeflash.toml (which doesn't exist) and
omitted Java from several pages despite being fully implemented.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude bot commented Apr 2, 2026

Claude finished @mashraf-222's task in 32s —— View job


No substantive code changes to review.

All 7 changed files are documentation-only (.md / .mdx). The PR updates Java docs, architecture notes, and getting-started guides — no production code was modified.

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.

2 participants