Skip to content

docs: Documentation audit improvements - tabbed syntax, expanded landing page, admonitions#504

Open
csharpfritz wants to merge 3 commits intoFritzAndFriends:devfrom
csharpfritz:squad/doc-improvements
Open

docs: Documentation audit improvements - tabbed syntax, expanded landing page, admonitions#504
csharpfritz wants to merge 3 commits intoFritzAndFriends:devfrom
csharpfritz:squad/doc-improvements

Conversation

@csharpfritz
Copy link
Collaborator

Documentation Audit & Improvements

Based on a comprehensive audit by Beast (cross-cutting quality) and Forge (organization/structure), this PR delivers the first wave of documentation improvements.

Changes

  • README.md - Expanded landing page with richer component references and navigation
  • Button.md - Converted to tabbed Web Forms vs Blazor syntax format with admonitions
  • Panel.md - Added tabbed syntax comparison and migration notes
  • CheckBox.md - Converted to tabbed format with property mapping
  • Strategies.md - Fixed placeholder content, added migration workflow guidance

Audit findings addressed

  • Inconsistent code block formatting across component docs
  • Missing Web Forms vs Blazor side-by-side comparisons
  • Sparse landing page that didn't help newcomers navigate
  • Placeholder content in migration strategy docs

Remaining work (tracked as follow-up tasks)

  • 22+ component docs still need tabbed syntax conversion
  • Stub docs need expansion (RegularExpressionValidator, ValidationSummary, Label, RequiredFieldValidator)
  • User-Controls.md migration guide needs ASCX workflow using new ViewState shims
  • Cross-linking between related components

csharpfritz and others added 3 commits March 24, 2026 10:42
…admonitions

- Expand docs/README.md with comprehensive landing page (~70 lines):
  - Clear 'What is BlazorWebFormsComponents?' explanation
  - 'Who this is for' section targeting brown-field developers
  - Quick Start installation and usage guide
  - Component overview by category (7 categories)
  - Migration resources and status links
  - Key features and considerations

- Convert 4 component files to use tabbed syntax (=== Web Forms / === Blazor):
  - Button.md: Side-by-side syntax comparison
  - Panel.md: Semantic HTML rendering explanation
  - CheckBox.md: Two-way binding patterns
  - Syntax sections now clearly show before/after migration

- Add admonitions throughout converted files:
  - Button.md: Command event bubbling tip, client script warning
  - Panel.md: Semantic HTML note, overflow handling note
  - CheckBox.md: Two-way binding tip, disabled state note

- Fix Strategies.md: Replace 'INSERT LINK' placeholder with actual link to sample _Imports.razor

Template patterns established:
- Tabbed syntax uses pymdownx.tabbed extension (already enabled in mkdocs.yml)
- Admonitions follow AjaxToolkit documentation style (tip, note, warning)
- Examples placed after tabbed syntax blocks for clarity

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… refactor + ASCX analysis

Session: 2026-03-24T14-37-19Z-doc-refactor-and-ascx-analysis
Scribe merge session

Changes:
- Created orchestration logs for Beast (4KB) and Forge (6KB)
- Created session log (4KB) summarizing 2-agent parallel work
- Merged 7 decision inbox items into decisions.md (deduplicated + consolidated)
- Deleted 7 inbox files after merge
- Updated Beast history.md with Forge's ASCX findings context
- Updated Forge history.md with Beast's doc audit context

Decisions Merged:
- Beast: Documentation Quality Audit (7 prioritized improvements)
- Beast: Documentation Refactor (6 executed tasks)
- Forge: ASCX User Control Drop-In Replacement Strategy (3-tier playbook)
- Forge: NuGet Static Asset Migration Strategy (extraction + CDN hybrid)
- Forge: Documentation Organization & Structure Review (5 priority recommendations)
- Copilot: User Directive (NuGet asset extraction)
- Jubilee: AfterDepartmentPortal Runnable Demo Setup

All agents read decisions.md; cross-agent context updated in histories.
…context

- Expanded README landing page with additional component references
- Updated Button.md formatting
- Logged Forge analysis context to history

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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