Skip to content

docs: audit getting started guide#13

Merged
demengc merged 1 commit intomainfrom
worktree-agent-a7f10299
Mar 24, 2026
Merged

docs: audit getting started guide#13
demengc merged 1 commit intomainfrom
worktree-agent-a7f10299

Conversation

@demengc
Copy link
Copy Markdown
Owner

@demengc demengc commented Mar 24, 2026

Summary

  • Verified all API references (method names, signatures, import paths) against source code in BasePlugin, BaseSettings, Text, and Events
  • Updated maven-shade-plugin (3.5.1 -> 3.6.1) and maven-compiler-plugin (3.11.0 -> 3.14.1) versions to match the project's own pom.xml
  • Clarified that the -parameters compiler flag is specifically needed for Lamp command argument name discovery
  • Added lifecycle method reference table documenting load(), enable(), and disable()
  • Added complete BaseSettings reference table with all methods, defaults, and descriptions
  • Expanded BaseSettings code example to show colorScheme() and includePrefixOnEachLine() overrides
  • Replaced generic headings with descriptive, action-oriented ones
  • Removed filler prose, redundant inline comments, and the empty "Build and Test" section
  • Added GitBook YAML frontmatter
  • Fixed XML indentation consistency in Maven dependency snippet

Test plan

  • Verify markdown renders correctly in GitBook preview
  • Confirm all code examples compile against current API
  • Check that Maven/Gradle coordinates resolve via JitPack

Verify all API references against source code and fix inaccuracies:
- Update maven-shade-plugin version from 3.5.1 to 3.6.1
- Update maven-compiler-plugin version from 3.11.0 to 3.14.1
- Clarify -parameters flag is specifically for Lamp command argument names
- Add lifecycle method reference table (load/enable/disable)
- Add complete BaseSettings reference table with defaults
- Expand BaseSettings example to show colorScheme() and includePrefixOnEachLine()
- Replace generic headings with descriptive ones
- Remove filler prose and inline comments that restate the obvious
- Add GitBook frontmatter
- Fix XML indentation in Maven dependency snippet
@demengc demengc merged commit af2834e into main Mar 24, 2026
2 of 3 checks passed
@demengc demengc deleted the worktree-agent-a7f10299 branch March 24, 2026 02:00
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