asciidoctor / asciidoctor-browser-extension

:white_circle: An extension for web browsers that converts AsciiDoc files to HTML using Asciidoctor.js.
https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia
MIT License
216 stars 53 forks source link

docs.asciidoctor.org/browser-extension shows Page not found, instead of docs.asciidoctor.org/browser-extension/latest/ #655

Closed sturtison closed 1 year ago

sturtison commented 1 year ago

The README.adoc directs the user to the user manual https://docs.asciidoctor.org/browser-extension

Expected behaviour: Opens the latest page for the browser extension.

Observed behaviour: Displays page not found in content pane with the docs menu on the left. NOTE: This is the same for all docs, eg https://docs.asciidoctor.org/asciidoc

Solution: Do we change the URL in README.adoc, or do something with the docs overall?

mojavelinux commented 1 year ago

If this is a versionless project from the user's perspective, what I recommend is setting the version to ~ in antora.yml to indicate there's only a single version and that the version value is not relevant. In this case, the version number will not be shown in the docs and the URL you cited will work.

If you want to retain the versioning, then the correct URL is https://docs.asciidoctor.org/browser-extension/latest/ (because a version must be specified).

ggrossetie commented 1 year ago

If this is a versionless project from the user's perspective, what I recommend is setting the version to ~ in antora.yml to indicate there's only a single version and that the version value is not relevant. In this case, the version number will not be shown in the docs and the URL you cited will work.

Versionless seems good 👍🏻

ggrossetie commented 1 year ago

Fixed!