Skip to content

docs: refresh v3 README and GIF baselines - #787

Merged
hdcodedev merged 1 commit into
mainfrom
docs/refresh-v3-readme-gifs
Oct 16, 2026
Merged

hdcodedev merged 1 commit into
mainfrom
docs/refresh-v3-readme-gifs

Conversation

@hdcodedev

Copy link
Copy Markdown
Member

Summary

  • Refresh all 24 docs GIF scenarios for the release; 23 baseline files changed.
  • Focus the README on v3 with a stacked-area example and a horizontal gradient across the bar plot, each paired with its matching GIF and data.
  • Update API guidance for sizing, styles, subtitles, selection, and live-line behavior, and link to the current v3 snapshot docs and demo.

Local Validation

  • ./gradlew ktlintCheck
  • ./gradlew :charts-<module>:jvmTest
  • ./gradlew chartsTestJvm
  • ./gradlew ciCompile
  • ./gradlew chartsCheck
  • ./gradlew apiCompatibilityCheck
  • ../charts-playground/gradlew -p ../charts-playground -DchartsLocalPath="$PWD" ciCompile
  • ./gradlew :androidApp:validateDebugScreenshotTest
  • ./gradlew updateScreenshots

Additional validation:

  • ./gradlew recordDocsGifs --no-daemon — passed on the running emulator; all 24 scenarios recorded.
  • ./gradlew :androidApp:compileDebugKotlin --no-daemon --console=plain — passed with all 11 README Compose snippets compiled through a temporary verification source, which was removed afterward.
  • git diff --check and git diff --cached --check — passed.
  • All declared GIF scenarios have non-empty baseline files. Local README links and assets resolve; representative frames from both embedded GIFs were inspected.

The checklist commands above were not run for this documentation and baseline refresh. GIF comparison remains a CI check.

@hdcodedev
hdcodedev merged commit a8100f2 into main Oct 16, 2026
21 checks passed
@hdcodedev
hdcodedev deleted the docs/refresh-v3-readme-gifs branch October 16, 2026 20:02
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