Skip to content

Fix malformed examples table on website#184

Merged
ejm714 merged 4 commits intomainfrom
jyq-fix-docs-table
Mar 23, 2026
Merged

Fix malformed examples table on website#184
ejm714 merged 4 commits intomainfrom
jyq-fix-docs-table

Conversation

@jayqi
Copy link
Copy Markdown
Member

@jayqi jayqi commented Mar 20, 2026

The examples table on the website got messed up at some point. This PR fixes it.

It also adds target="_blank" to open example reference links in new tabs.


Before

Screenshot 2026-03-20 at 3 00 49 PM

After

Screenshot 2026-03-20 at 3 01 09 PM

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.80%. Comparing base (457aa98) to head (8d771fe).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #184   +/-   ##
=======================================
  Coverage   96.80%   96.80%           
=======================================
  Files           6        6           
  Lines         188      188           
=======================================
  Hits          182      182           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR repairs the Markdown formatting of the “Examples” table used by the MkDocs site so it renders correctly again, and updates example reference links to open in new tabs.

Changes:

  • Fix the generated Markdown table header/row formatting for the examples table.
  • Switch example links from Markdown-in-HTML to explicit HTML <a> tags and add target="_blank".
  • Update the committed docs/docs/examples.md output to match the corrected table/link format.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/render_templates.py Updates the table and link HTML generation used to render the examples page.
docs/docs/examples.md Updates the rendered examples table markup and link format in the published docs page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jayqi
Copy link
Copy Markdown
Member Author

jayqi commented Mar 20, 2026

@ejm714 quick PR that I'd appreciate if you can get to

@ejm714 ejm714 marked this pull request as ready for review March 23, 2026 20:46
@jayqi jayqi temporarily deployed to jyq-fix-docs-table - deon PR #184 March 23, 2026 20:56 — with Render Destroyed
@ejm714 ejm714 merged commit 8a31cf7 into main Mar 23, 2026
26 checks passed
@ejm714 ejm714 deleted the jyq-fix-docs-table branch March 23, 2026 20:57
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.

3 participants