Skip to content

Commit e906eac

Browse files
authored
Update regarding Antora, etc.
1 parent 32aa9e4 commit e906eac

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,13 @@ define the source file coding standards we use along with some IDEA editor setti
123123

124124
### Reference Docs
125125

126-
The reference documentation is in the [framework-docs/src/docs/asciidoc](framework-docs/src/docs/asciidoc) directory, in
127-
[Asciidoctor](https://asciidoctor.org/) format. For trivial changes, you may be able to browse,
128-
edit source files, and submit directly from GitHub.
126+
The reference documentation is authored in [Asciidoctor](https://asciidoctor.org/) format
127+
using [Antora](https://docs.antora.org/antora/latest/). The source files for the documentation
128+
reside in the [framework-docs/modules/ROOT](framework-docs/modules/ROOT) directory. For
129+
trivial changes, you may be able to browse, edit source files, and submit directly from GitHub.
129130

130-
When making changes locally, execute `./gradlew :framework-docs:asciidoctor` and then browse the result under
131-
`framework-docs/build/docs/ref-docs/html5/index.html`.
131+
When making changes locally, execute `./gradlew antora` and then browse the results under
132+
`framework-docs/build/site/index.html`.
132133

133134
Asciidoctor also supports live editing. For more details see
134135
[AsciiDoc Tooling](https://docs.asciidoctor.org/asciidoctor/latest/tooling/).
135-

0 commit comments

Comments
 (0)