Skip to content

feat: tutorials coverage matrix with deep links and collapsible sections - #1164

Open
oduameh wants to merge 1 commit into
mainfrom
tutorials-coverage-matrix
Open

feat: tutorials coverage matrix with deep links and collapsible sections#1164
oduameh wants to merge 1 commit into
mainfrom
tutorials-coverage-matrix

Conversation

@oduameh

@oduameh oduameh commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds an interactive coverage matrix to the tutorials landing page (/tutorials), mapping the five written tutorials (Bulletin board, Private party, Battleship, Leaderboard, ZK Loan) against 89 features grouped into 10 collapsible sections. Data is sourced from the team's written-tutorials coverage spreadsheet.

  • Collapsed section rows show per-tutorial coverage counts as pills colored by tutorial type (DApp / Contract), so the matrix reads at a glance without expanding anything.
  • Every mark and "Taught by" chip deep-links to the exact tutorial section that covers the feature (for example, Battleship's "Ledger List" dot goes to /tutorials/bship/smart-contract#shoot-circuits).
  • A feature dropdown (grouped by section) filters the table and lists which tutorials teach the selected feature.
  • The tutorials landing page becomes full width (hide_table_of_contents: true, same pattern as the overview landing page) and the matrix stretches to fill the content column.
  • The CoverageMatrix component is generalized via props with all defaults preserved: the examples matrix on /examples renders exactly as before.

Type of Change

  • Site improvement (UI/UX, infrastructure)

Related Links

Issue Reference

Checklist

  • Followed the Midnight Style Guide.
  • Previewed changes locally (npm run start or yarn start).
  • Updated navigation metadata if needed (sidebar, menus).

Notes

  • yarn build passes; all 89 unique deep-link anchors were validated against the built HTML (the collapsed default hides most links from Docusaurus's own broken-anchor pass, so a direct check was run).
  • Marks: filled dot = taught in depth, outlined dot = touched briefly. The two-tier scheme matches the coverage spreadsheet.
  • No changes to any tutorial content pages; only the landing page, the shared component, and the new data file.

…ections

Add an interactive coverage matrix to the tutorials landing page mapping
the five written tutorials (Bulletin board, Private party, Battleship,
Leaderboard, ZK Loan) against 89 features across 10 sections, sourced
from the team's written-tutorials coverage spreadsheet.

- Generalize the CoverageMatrix component with props for columns,
  features, labels, and a stretch mode; the examples matrix on /examples
  is unchanged (all defaults preserved).
- Features can carry a section: sections render as collapsible rows
  showing per-tutorial coverage-count pills colored by DApp/Contract
  group, with an Expand all control.
- Cells can carry an href: every mark and summary chip deep-links to the
  tutorial section that covers the feature. All 89 unique anchors are
  validated against the built site.
- Make the tutorials landing page full width (hide_table_of_contents)
  so the matrix spreads across the content column.
@oduameh
oduameh requested review from a team as code owners July 30, 2026 17:50
@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
midnight-wiki Ready Ready Preview Jul 30, 2026 5:57pm

Request Review

@github-actions

Copy link
Copy Markdown

Summary

Status Count
🔍 Total 1
🔗 Unique 1
✅ Successful 1
⏳ Timeouts 0
🔀 Redirected 1
👻 Excluded 0
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0

Redirects per input

Redirects in docs/tutorials/index.mdx

Full Github Actions output

Comment thread docs/tutorials/index.mdx
Comment thread docs/tutorials/index.mdx
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Deployment Ready

🔗 Preview URL: https://pr-1164-midnight-docs.vercel.app

📝 Latest commit: 7c6c323
Updated: Jul 30, 2026, 5:57 PM UTC


This preview updates automatically when you push new commits to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

IN PROGRESS Actively being worked

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants