Skip to content

doc: replace large tables in crypto.md and webcrypto.md with lists#64582

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
panva:doc-tables-poof
Jul 20, 2026
Merged

doc: replace large tables in crypto.md and webcrypto.md with lists#64582
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
panva:doc-tables-poof

Conversation

@panva

@panva panva commented Jul 18, 2026

Copy link
Copy Markdown
Member

Because the current tables aren't compatible with the (subjective opinion trigger warning ⚠️ ) overly narrow main content section of the doc redesign.

Signed-off-by: Filip Skokan <panva.ip@gmail.com>
@panva
panva requested a review from avivkeller July 18, 2026 17:47
@panva panva added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. webcrypto labels Jul 18, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/crypto

@panva panva added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 18, 2026
Comment thread doc/api/crypto.md
[`KeyObject`][] API by the complete set of formats supported for importing and
exporting each type.

**Formats:** `'pem'`, `'der'`

@Trott Trott Jul 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Non-blocking observation: For semantic and accessibility purposes I think it would be better if these bold-text pseudo-headers were themselves bullet items and then the current bullet items could be indented under them. That would be likely to preserve accessibility and would certainly be more semantically intelligible. But I don't know if it would be as visually appealing. Right now, there's nothing associating these headers with the list semantically. However this can be something for subsequent discussion.

Another option is to make them headers, but that might make weird table-of-contents entries and stuff like that if we're not careful.

@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 20, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 5b27fb9 into nodejs:main Jul 20, 2026
35 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 5b27fb9

@panva
panva deleted the doc-tables-poof branch July 20, 2026 18:27
aduh95 pushed a commit that referenced this pull request Jul 21, 2026
Signed-off-by: Filip Skokan <panva.ip@gmail.com>
PR-URL: #64582
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
aduh95 pushed a commit that referenced this pull request Jul 21, 2026
Signed-off-by: Filip Skokan <panva.ip@gmail.com>
PR-URL: #64582
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
aduh95 pushed a commit that referenced this pull request Jul 21, 2026
Signed-off-by: Filip Skokan <panva.ip@gmail.com>
PR-URL: #64582
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. webcrypto

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants