docs: correct package names and audit documentation#194
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-derivedPackageIdand 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
dotnet add/Install-Package/<PackageReference>snippets and NuGet badges acrossREADME.md,CLAUDE.md, and the four per-library READMEs.usingdirectives in code examples updated to the shipped namespaces (ktsu.ImGui.App, etc.).ktsu-dev/ImGuiApp) was intentionally left as-is.Audit fixes (verified against source)
Styler
Theme.Reset()→Theme.ResetToDefault()Theme.IsCurrentThemeDarkColor.FromHSV→Color.FromHSLColor.Lighten/Darken/GetOptimalTextColorwere never staticColormethods — documented as the actualImColorextension methods (LightenBy,DarkenBy,CalculateOptimalContrastingColor,GetContrastRatioOver)new ScopedTheme("string")→new ScopedTheme(ISemanticTheme)Widgets
IconDelegates→IconOptions, dropped the non-existentColorparameter, useImGuiAppTextureInfo.TextureIdRowMajorGridwith anidand the correctCalcIconSizeoverloadColorIndicatorargument order/types correctedColumns/Rows,Add(),Tick()(wasHorizontal/Vertical,AddZone(),Draw())Popups
FilesystemBrowser.Open(mode, target, …)→FileOpen/FileSave/ChooseDirectoryktsu.Semantics.Paths/Strings, notktsu.StrongPaths)App / Root
EmsToPx/PtsToPxdocumented as returningintImGuiWidgets.TabPanel, etc.)Testing
Docs-only change; all referenced APIs were verified against the current source.
https://claude.ai/code/session_013SjKypvXUFBVfTVrfCxt9D
Generated by Claude Code