[Repo Assist] Improve markdown API docs: section-based member layout instead of tables#1026
Conversation
Replace the 3-column Markdown table in renderMembers with per-member section headings (####). This eliminates: - <br /> separators crammed into table cells - | pipe-character escaping for operators/unions - constrained layout for multi-line content and code examples Each member now gets an HTML anchor (<a name="..."></a>) for backward- compatible per-member links, followed by a #### heading with the usage signature, then properly separated paragraphs for summary, parameters, return type, notes, and examples. The entities summary table (types/modules list) is unchanged. All 69 existing tests pass. Closes #725 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
/repo-assist add some tests to this |
Test coverage for issue #725 fix: - Section headings (####) instead of table rows - HTML anchors for backward-compatible member links - ##### Example / Note headings - **Parameters:** section for members with parameters - No embedded <br /> in member descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Commit pushed:
|
|
🤖 This is an automated response from Repo Assist. I've added three new tests to
All 25 tests pass locally on this branch.
|
|
/repo-assist remove parameter |
…rkdown.fs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Commit pushed:
|
…-0454594620717e94
🤖 This is an automated PR from Repo Assist.
Problem
Markdown output for API docs (issue #725) was very messy because member documentation was rendered in a 3-column Markdown table. Markdown tables can't contain block-level content, so everything was crammed into cells using HTML hacks:
<br />to separate sections within a description cell|to escape|characters in operator/union signatures<br />within examples, notes, and return-type docsBefore (
fslib-nested.md):After:
After:
Change
renderMembersinGenerateMarkdown.fsnow generates per-member####sections instead of table rows:(a name="...")(/a)before each member heading for backward-compatible#MemberNamelinks####heading with the full usage signature (HTML)The entities summary table (types/modules list in namespace pages) is unchanged — that content is single-line and benefits from the compact table layout.
embedSafe(which added<br />/|escaping) is replaced withembedthroughoutrenderMemberssince we're no longer inside table cells.Remaining HTML
Some HTML still appears in the output and would require further work:
in member signatures (fromcodeHtmlinGenerateModel.fs)<code><span>wrapping in member headings (fromUsageHtml)<p>tags in inline-mode summaries (from the HTML-based XML doc pipeline)onmouseover/(div class="fsdocs-tip")tooltip elements in syntax-highlighted examplesThese are separate from this PR's scope.
Test Status
✅ All 69 ApiDocs tests pass. No tests were changed; all existing assertions are satisfied by the new section-based output.