docs: rename "JSDoc" to "API Reference" and add link to extension API reference #1447
Conversation
| @@ -1,6 +1,7 @@ | |||
| = Extensions | |||
|
|
|||
| Asciidoctor provides an extension API that offers a xref:extensions/register.adoc[list of extension points] that open up the language to new use cases. | |||
| https://asciidoctor.github.io/asciidoctor.js/{jsdoc-version}/#extensions[Extension API Reference] | |||
There was a problem hiding this comment.
We should probably "introduce" this link, something like:
| https://asciidoctor.github.io/asciidoctor.js/{jsdoc-version}/#extensions[Extension API Reference] | |
| Please refer to the https://asciidoctor.github.io/asciidoctor.js/{jsdoc-version}/#extensions[API Reference] to learn more about the Asciidoctor.js API. |
What do you think?
There was a problem hiding this comment.
Plus since its linking to the extensions section, it would be "...Asciidoctor.js Extension API"
docs/modules/processor/nav.adoc
Outdated
| @@ -4,4 +4,4 @@ | |||
| ** xref:extract-api.adoc[Extract information from a document] | |||
| ** xref:manipulate-api.adoc[Manipulate a document] | |||
| ** xref:logging-api.adoc[Logging] | |||
| * https://asciidoctor.github.io/asciidoctor.js/{jsdoc-version}/[JSDoc] | |||
| * https://asciidoctor.github.io/asciidoctor.js/{jsdoc-version}/[API Reference] | |||
There was a problem hiding this comment.
For reference, here's how it will look like:
I wonder if we should remove the "s" in "CLI References". I actually don't remember why we put an "s" 😅
And maybe we should put the "API Reference" after "Extend & Customize"?
There was a problem hiding this comment.
And maybe we should put the "API Reference" after "Extend & Customize"?
I was thinking this, but I didnt know if there was a specific reason why JSDOC was in the processor nav file
|
Thanks @hqurve 👍🏻 |
|
@Mogztter It appears as if I ended up doing more harm than good. Its no longer showing the
|
|
Indeed, the list structure was incorrect: 02ba973
|
No description provided.