Skip to content

Commit 3858861

Browse files
michaelcoxMylesBorins
authored andcommitted
tools: add links to the stability index reference
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]>
1 parent e3105cf commit 3858861

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

tools/doc/html.js

+4-1
Original file line numberDiff line numberDiff line change
@@ -322,9 +322,12 @@ function linkJsTypeDocs(text) {
322322
}
323323

324324
function parseAPIHeader(text) {
325+
const classNames = 'api_stability api_stability_$2';
326+
const docsUrl = 'documentation.html#documentation_stability_index';
327+
325328
text = text.replace(
326329
STABILITY_TEXT_REG_EXP,
327-
'<pre class="api_stability api_stability_$2">$1 $2$3</pre>'
330+
`<pre class="${classNames}"><a href="${docsUrl}">$1 $2</a>$3</pre>`
328331
);
329332
return text;
330333
}

0 commit comments

Comments
 (0)