Reorganize docs for wiki links

scala · May 11, 2021 · 36b25cf · 36b25cf
1 parent 0288354
commit 36b25cf
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/docs/docs/usage/scaladoc/docComments.md → ...cs/usage/scaladoc/linkingDocumentation.md b/docs/docs/usage/scaladoc/docComments.md → ...cs/usage/scaladoc/linkingDocumentation.md
@@ -1,5 +1,5 @@
 ---
-title: API Documentation
+title: Linking documentation
 ---
 
 # {{ page.title }}

diff --git a/docs/docs/usage/scaladoc/scaladocDocstrings.md b/docs/docs/usage/scaladoc/scaladocDocstrings.md
@@ -121,8 +121,8 @@ Scaladoc provides two syntax parsers: `markdown` (default) or `wikidoc`.
 
 #### Markdown
 
-Markdown uses commonmark flavour to parse docstring, however it can understand `wikidoc` links.
-For more info about wiki links look at this [chapter](#linking-to-api)
+Markdown uses [commonmark flavour](https://spec.commonmark.org/current/) with extension of `wikidoc` links for referencing convenience.
+
 
 #### Wikidoc
 
@@ -142,6 +142,8 @@ __underline__
 [[https://external.link External Link]], e.g. [[https://scala-lang.org Scala Language Site]]
 ```
 
+For more info about wiki links look at this [chapter](#linking-to-api)
+
 Other formatting notes
 
 - Paragraphs are started with one (or more) blank lines. `*` in the margin for the comment is valid (and should be included) but the line should be blank otherwise.
@@ -179,10 +181,8 @@ More details on writing Scaladoc
 
 Further information on the formatting and style recommendations can be found in Scala-lang scaladoc style guide.
 
-
-
 ## Linking to API
 
 Scaladoc allows linking to API documentation with Wiki-style links. Linking to
 `scala.collection.immutable.List` is as simple as
-`[[scala.collection.immutable.List]]`. For more information on the exact syntax, see [doc comment documentation](./docComments.html#definition-links).
+`[[scala.collection.immutable.List]]`. For more information on the exact syntax, see [doc comment documentation](./linkingDocumentation.html#definition-links).
diff --git a/docs/docs/usage/scaladoc/settings.md b/docs/docs/usage/scaladoc/settings.md
@@ -40,17 +40,17 @@ Revision (branch or ref) used to build project project. Useful with sourcelinks
 Source links provide a mapping between file in documentation and code repository.
 
 Accepted formats:
-<\sub-path>=<\source-link>
-<\source-link>
+\<sub-path>=\<source-link>
+\<source-link>
 
-where <\source-link> is one of following:
+where <source-link> is one of following:
  - `github://<organization>/<repository>[/revision][#subpath]`
      will match https://github.com/$organization/$repository/\[blob|edit]/$revision\[/$subpath]/$filePath\[$lineNumber]
      when revision is not provided then requires revision to be specified as argument for scaladoc
  - `gitlab://<organization>/<repository>`
      will match https://gitlab.com/$organization/$repository/-/\[blob|edit]/$revision\[/$subpath]/$filePath\[$lineNumber]
      when revision is not provided then requires revision to be specified as argument for scaladoc
- - <\scaladoc-template>
+ - \<scaladoc-template>
 
 <scaladoc-template> is a format for `doc-source-url` parameter scaladoc.
 NOTE: We only supports `€{FILE_PATH_EXT}`, `€{TPL_NAME}`, `€{FILE_EXT}`,