Skip to content

Commit 9882f22

Browse files
Merge pull request #78 from OpenSimulationInterface/Fix_for_issue_77
Fix Link to Hosted documents in readme
2 parents 7d56de6 + 1b5d6d6 commit 9882f22

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
= OSI Documentation
22

33
This repo hosts the AsciiDoc-based part of the documentation.
4-
It contains generals parts of the content and a CI-pipeline that renders the document with Asciidoctor and deploys it to the https://opensimulationinterface.github.io/osi-documentation/[gh-pages of this repo].
4+
It contains generals parts of the content and a CI-pipeline that renders the document with Antora.
55

66
// TODO: Update if Asciidoctor is completely dropped!
77

88
== ASAM OSI (R) official documentation
99

10-
See the documentation https://opensimulationinterface.github.io/osi-documentation/[here].
10+
See the documentation https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html[here].
1111

1212

1313
== Build pipeline
14-
=== Asciidoctor pipeline
14+
// === Asciidoctor pipeline
1515

16-
image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml]
16+
// The Asciidoctor pipline is no longer active, see Antora pipeline.
1717

18-
The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo.
19-
As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc].
18+
// image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml]
19+
20+
// The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo.
21+
// As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc].
2022

2123
=== Antora pipeline
2224
image::https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml/badge.svg?branch=main[link=https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml]
@@ -78,4 +80,4 @@ git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.
7880
docker-compose run asciidoctor
7981
----
8082

81-
. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation.
83+
. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation.

0 commit comments

Comments
 (0)