Skip to content

Conversation

@dagood
Copy link
Member

@dagood dagood commented Jan 23, 2026

Some footnotes can be a bit tricky to associate with the list at the end of the table, so try adding a details element to make them clickable:

image

This should have no content change, just formatting.

@dagood dagood requested a review from a team as a code owner January 23, 2026 19:36
Copy link
Member

@qmuntal qmuntal left a comment

Choose a reason for hiding this comment

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

The footnotes are hard to follow, that's a real issue. On the other hand, I'm don't quite like the solution proposed here:

  • Each table entry with a footnote now will have an arrow and a superscript number, which feels like too noisy.
  • It is not directly evident that clicking the arrow will expand the entry, nor that the expanded content is the same as the footnote down below.
  • The table layout changes when the entry is expanded, and expanding too many entries makes the table unreadable
  • The markdown source code is uglier (nit)

I would prefer something like native GitHub Markdown footnotes instead, see https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/.

@dagood
Copy link
Member Author

dagood commented Jan 26, 2026

I would prefer something like native GitHub Markdown footnotes instead, see https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/.

Same, but they're all rendered way down at the end of the file. (And since this means everything piles up, the "back to source" buttons probably end up being overwhelming visual clutter too.) I also don't think this helps when there are multiple footnotes per cell.

I'll try <sup title="foo">1,2</sup> for mouse hover to see how that looks. Not copyable, depends on browser, no formatting and newlines, and doesn't improve raw markdown formatting, but less intrusive when rendered.

@dagood
Copy link
Member Author

dagood commented Jan 26, 2026

Hover text would need more processing to strip links:

image

At its best, looks like this:

image

Abandoning this for now.

@dagood dagood closed this Jan 26, 2026
@dagood dagood deleted the dev/dagood/crossplatcrypto-clicky branch January 26, 2026 19:49
@dagood
Copy link
Member Author

dagood commented Jan 26, 2026

Then next approach I'd try is to have every row link to its section in https://github.com/microsoft/go/blob/microsoft/main/eng/doc/fips/UserGuide.md, where each requirement is also laid out in full text.

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.

4 participants