Skip to content

docs: correct package names and audit documentation#194

Merged
matt-edmondson merged 1 commit into
mainfrom
claude/laughing-cori-0Bg02
May 30, 2026
Merged

docs: correct package names and audit documentation#194
matt-edmondson merged 1 commit into
mainfrom
claude/laughing-cori-0Bg02

Conversation

@matt-edmondson
Copy link
Copy Markdown
Contributor

Summary

The documentation referenced the legacy, dot-less NuGet package IDs (ktsu.ImGuiApp, ktsu.ImGuiWidgets, ktsu.ImGuiStyler, ktsu.ImGuiPopups), which are abandoned at v1.x/2.1.x. The packages the repo actually builds and publishes today (v2.5.0) use dotted IDs: ktsu.ImGui.App, ktsu.ImGui.Widgets, ktsu.ImGui.Styler, ktsu.ImGui.Popups (confirmed via the ktsu.Sdk-derived PackageId and the namespaces in source). This PR updates every install snippet, badge, and namespace in the docs to the correct names, and audits the rest of the documentation for accuracy while doing so.

The per-library READMEs turned out to be stale copies from the original standalone repos, so the audit caught a number of code examples referencing APIs that no longer exist (or never did).

Package name / namespace fixes

  • All dotnet add / Install-Package / <PackageReference> snippets and NuGet badges across README.md, CLAUDE.md, and the four per-library READMEs.
  • using directives in code examples updated to the shipped namespaces (ktsu.ImGui.App, etc.).
  • The repo/suite brand name in the root README H1/intro (matching ktsu-dev/ImGuiApp) was intentionally left as-is.

Audit fixes (verified against source)

Styler

  • Theme.Reset()Theme.ResetToDefault()
  • Removed non-existent Theme.IsCurrentThemeDark
  • Color.FromHSVColor.FromHSL
  • Color.Lighten/Darken/GetOptimalTextColor were never static Color methods — documented as the actual ImColor extension methods (LightenBy, DarkenBy, CalculateOptimalContrastingColor, GetContrastRatioOver)
  • new ScopedTheme("string")new ScopedTheme(ISemanticTheme)
  • Standardized theme names to the space-separated form the registry/demo use

Widgets

  • Icon example: IconDelegatesIconOptions, dropped the non-existent Color parameter, use ImGuiAppTextureInfo.TextureId
  • Grid example: RowMajorGrid with an id and the correct CalcIconSize overload
  • ColorIndicator argument order/types corrected
  • DividerContainer: Columns/Rows, Add(), Tick() (was Horizontal/Vertical, AddZone(), Draw())

Popups

  • FilesystemBrowser.Open(mode, target, …)FileOpen / FileSave / ChooseDirectory
  • Corrected dependency list (ktsu.Semantics.Paths/Strings, not ktsu.StrongPaths)

App / Root

  • Supported frameworks corrected to .NET 8/9/10
  • EmsToPx/PtsToPx documented as returning int
  • Qualified nested widget types (ImGuiWidgets.TabPanel, etc.)
  • Standalone clone/demo commands pointed at this repo

Testing

Docs-only change; all referenced APIs were verified against the current source.

https://claude.ai/code/session_013SjKypvXUFBVfTVrfCxt9D


Generated by Claude Code

Update all documentation to use the actual current NuGet package IDs
(ktsu.ImGui.App, ktsu.ImGui.Widgets, ktsu.ImGui.Styler, ktsu.ImGui.Popups)
instead of the legacy dot-less names, and fix namespaces in code examples
to match the shipped namespaces.

Audit fixes uncovered along the way:
- Styler: Theme.Reset -> ResetToDefault; removed non-existent
  Theme.IsCurrentThemeDark; Color.FromHSV -> FromHSL; Color.Lighten/Darken/
  GetOptimalTextColor were never static - documented as ImColor extension
  methods (LightenBy/DarkenBy/CalculateOptimalContrastingColor); ScopedTheme
  takes ISemanticTheme, not a string; standardized theme names to the
  space-separated form used by the registry/demo.
- Widgets: fixed Icon example (IconDelegates -> IconOptions, dropped the
  non-existent Color parameter, TextureId from ImGuiAppTextureInfo); Grid
  example uses RowMajorGrid with an id and correct CalcIconSize overload;
  ColorIndicator argument order/types; DividerContainer uses Columns/Rows,
  Add(), and Tick() instead of Horizontal/Vertical, AddZone(), Draw().
- Popups: FilesystemBrowser uses FileOpen/FileSave/ChooseDirectory; corrected
  dependency list (ktsu.Semantics.Paths/Strings, not ktsu.StrongPaths).
- App: corrected supported frameworks (.NET 8/9/10).
- Root README: EmsToPx/PtsToPx return int; qualified nested widget types;
  pointed standalone clone/demo commands at this repo.

https://claude.ai/code/session_013SjKypvXUFBVfTVrfCxt9D
@matt-edmondson matt-edmondson merged commit d6c654a into main May 30, 2026
1 check passed
@matt-edmondson matt-edmondson deleted the claude/laughing-cori-0Bg02 branch May 30, 2026 02:57
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