Skip to content

Polish IntelligenceX API docs UI and theme contract#1226

Open
PrzemyslawKlys wants to merge 1 commit intomasterfrom
codex/intelligencex-apidocs-polish
Open

Polish IntelligenceX API docs UI and theme contract#1226
PrzemyslawKlys wants to merge 1 commit intomasterfrom
codex/intelligencex-apidocs-polish

Conversation

@PrzemyslawKlys
Copy link
Member

@PrzemyslawKlys PrzemyslawKlys commented Mar 25, 2026

Summary

  • style the enhanced namespace combobox, TOC toggle, inherited-members checkbox, show-all controls, and API sidebar scroll behavior so the generated docs UI is fully themed instead of leaking native controls
  • remove wasted right-rail space on API overview pages and tighten the IntelligenceX theme manifest contract for API-doc-specific selectors
  • align the website with the engine-side API docs hardening and richer example media contract from Harden API docs quality, media, and PowerShell example workflows PSPublishModule#226

Testing

  • ./build.ps1

@intelligencex-review
Copy link

intelligencex-review bot commented Mar 25, 2026

IntelligenceX Review

Reviewing PR #1226: Polish IntelligenceX API docs styling
Reviewed commit: 0bed21b

Merge blockers: items in Todo List ✅ and Critical Issues ⚠️ sections (if present). Other Issues 🧯 are suggestions.

Summary 📝

Solid styling cleanup overall. The diff is mostly maintainable, and the manifest update matches the new API-doc-specific selectors. I did not find a clear merge-blocking correctness issue in the shown changes.

Todo List ✅

None.

Other Issues 🧯

  • Website/static/css/api.css: hiding .namespace-select.pf-enhanced-native with left: -9999px, opacity: 0, and pointer-events: none can reduce accessibility if the enhanced combobox JS fails or assistive tech relies on the native control; prefer a standard visually-hidden pattern that keeps it operable.
    Rationale: this avoids a broken namespace selector fallback path.
  • Website/static/css/api.css: .type-toc.collapsed ul { display: none; } collapses all nested ul elements under .type-toc, not just the top-level list.
    Rationale: broader selectors make future markup changes fragile and can hide unintended content.
  • Website/static/css/api.css: the new color-mix() and backdrop-filter usage has no fallback values in the same rules.
    Rationale: unsupported browsers will degrade inconsistently, which is a maintainability and compatibility risk for docs pages.
  • Website/static/css/api.css: changing .api-sidebar from overflow-y: auto to overflow: hidden makes sidebar scrolling dependent on the new inner shell/layout. Verify every API page template uses .api-sidebar-shell.
    Rationale: any page missing that wrapper will lose sidebar scroll entirely.

Tests / Coverage 🧪

  • PR notes only mention running .\build.ps1; I don't see evidence of targeted verification for API overview/type pages in both light and dark themes.
  • Please verify: sidebar scroll on long nav trees, namespace combobox open/close behavior, TOC collapse/expand, and inherited-member toggle styling on narrow viewports.

Next Steps 🚀

  • Mergeable from the diff shown, after a quick manual regression pass on API docs pages for scrolling and interactive controls.

Static Analysis Policy 🧭

  • Config mode: respect
  • Packs: All Essentials (50)
  • Rules: 108 enabled
  • Rule list display: up to 10 items per section
  • Enabled rules preview: CA2000 (Dispose objects before losing scope), CA1062 (Validate arguments of public methods), SA1600 (Elements should be documented), CA1016 (Mark assemblies with assembly version), CA1018 (Mark attributes with AttributeUsageAttribute), CA1041 (Provide ObsoleteAttribute message), CA1047 (Do not declare protected member in sealed type), CA1050 (Declare types in namespaces), CA1061 (Do not hide base class methods), CA1067 (Override Object.Equals(object) when implementing IEquatable<T>) (truncated)
  • Result files: 2 input patterns, 1 matched, 1 parsed, 0 failed
  • Status: pass
  • Rule outcomes: 0 with findings, 108 clean
  • Failing rules: none
  • Clean rules: CA2000 (Dispose objects before losing scope), CA1062 (Validate arguments of public methods), SA1600 (Elements should be documented), CA1016 (Mark assemblies with assembly version), CA1018 (Mark attributes with AttributeUsageAttribute), CA1041 (Provide ObsoleteAttribute message), CA1047 (Do not declare protected member in sealed type), CA1050 (Declare types in namespaces), CA1061 (Do not hide base class methods), CA1067 (Override Object.Equals(object) when implementing IEquatable<T>) (truncated)
  • Outside-pack rules: none

Static Analysis 🔎

  • Findings: 0 (no issues at or above configured severity)

Model & Usage 🤖

  • Model: gpt-5.4
  • Length: medium
  • Mode: hybrid
  • Reasoning: not configured
  • Usage: 5h limit: 84% remaining | weekly limit: 90% remaining | code review weekly limit: 59% remaining | credits: 0

@PrzemyslawKlys PrzemyslawKlys changed the title Polish IntelligenceX API docs styling Polish IntelligenceX API docs UI and theme contract Mar 25, 2026
@PrzemyslawKlys
Copy link
Member Author

Companion engine PR: https://github.com/EvotecIT/PSPublishModule/pull/226\n\nRecommended review split:\n- review this PR for IntelligenceX-specific CSS/theme adoption\n- review the PSPublishModule PR for the shared API docs generator, contracts, validation, media, and pipeline work that this site now benefits from

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