Skip to content

Docs enhancements: grid cards, compilable examples, markdown extensions (#125)#125

Merged
pambrose merged 1 commit intomasterfrom
docs-enhancements
Apr 6, 2026
Merged

Docs enhancements: grid cards, compilable examples, markdown extensions (#125)#125
pambrose merged 1 commit intomasterfrom
docs-enhancements

Conversation

@pambrose
Copy link
Copy Markdown
Owner

@pambrose pambrose commented Apr 6, 2026

Summary

  • Converted "Next Steps" bullet lists to mkdocs-material grid cards on index, getting-started, and configuration overview pages
  • Added API Reference section with KDocs link above Next Steps on index page
  • Extracted Java/Kotlin code examples into compilable source files (EmbeddedAgentJavaExample.java, EmbeddedAgentKotlinExample.kt) so API changes are caught by the compiler
  • Updated EmbeddedAgentInfo to accept Agent argument; rewrote tests with MockK
  • Added markdown extensions: admonition, pymdownx.details, attr_list, md_in_html, pymdownx.emoji (with material icon support)

Test plan

  • Verify grid cards render correctly on index, getting-started, and configuration pages
  • Verify admonitions (!!! tip) render correctly
  • Verify material/octicons icons render in grid cards
  • Verify KDocs link works from API Reference section
  • Verify ./gradlew build compiles the new Java/Kotlin example files
  • Verify EmbeddedAgentInfoTest passes

🤖 Generated with Claude Code

- Convert "Next Steps" bullet lists to mkdocs-material grid cards on
  index, getting-started, and configuration overview pages
- Add API Reference section with KDocs link on index page
- Extract Java/Kotlin code examples from .txt into compilable source
  files so API changes are caught by the compiler
- Update EmbeddedAgentInfo to accept Agent, rewrite tests with MockK
- Add markdown extensions: admonition, details, attr_list, md_in_html,
  pymdownx.emoji with material icon support
- Add src/test/java/website to snippet base_path

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@pambrose pambrose merged commit a922570 into master Apr 6, 2026
3 checks 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