Skip to content

[Docs]: Convert HTML tables to Markdown in documentation#39

Closed
anukiransolur wants to merge 2 commits intomainfrom
docs/11019/convert-html-tables-to-markdown
Closed

[Docs]: Convert HTML tables to Markdown in documentation#39
anukiransolur wants to merge 2 commits intomainfrom
docs/11019/convert-html-tables-to-markdown

Conversation

@anukiransolur
Copy link
Contributor

Summary

Converted 9 HTML tables to Markdown format for better LLM parseability and maintainability.

Changes

  • docs/guides/events.md - Converted 8 event payload tables from HTML to Markdown

    • Record Created event
    • Record Updated event
    • Record Deleted event
    • File Uploaded event
    • Resolver Executed event
    • User Created event (IdP)
    • User Updated event (IdP)
    • User Deleted event (IdP)
  • docs/guides/tailordb/advanced-settings/overview.md - Converted 1 settings table from malformed HTML to Markdown

Benefits

  • 🤖 Improved LLM parsing - Markdown tables are easier for AI models to understand
  • 📊 Better version control - Cleaner diffs in git history
  • 🛠️ Easier maintenance - Markdown is simpler to edit than HTML
  • Universal support - All Markdown renderers support table syntax

Example Conversion

Before (HTML):

<table>
<thead>
  <tr>
    <th>Field Name</th>
    <th>Description</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>\`workspaceId\`</td>
    <td>\`String\`: The workspace ID.</td>
  </tr>
</tbody>
</table>

After (Markdown):

| Field Name | Description |
|------------|-------------|
| \`workspaceId\` | \`String\`: The workspace ID where the event occurred. |
| \`namespaceName\` | \`String\`: Name of the application. |

Test Plan

  • All HTML table tags removed (verified with grep)
  • Markdown tables render correctly in VitePress
  • Build check passes
  • Link check passes
  • Schema validation passes

Fixes tailor-inc/platform-core-services#11019

🤖 Generated with Claude Code

k1LoW and others added 2 commits March 18, 2026 17:21
- Converted 8 HTML tables to Markdown in docs/guides/events.md
- Converted 1 malformed HTML table to Markdown in docs/guides/tailordb/advanced-settings/overview.md

Benefits:
- Improved LLM parseability
- Better version control diffs
- Easier maintenance
- Universal Markdown support

Fixes #11019

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@anukiransolur anukiransolur marked this pull request as ready for review March 18, 2026 19:49
@anukiransolur anukiransolur requested a review from a team as a code owner March 18, 2026 19:49
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