Skip to content

Commit

Permalink
chore: Build docs in strict mode, so that mistakes are detected (DEV-…
Browse files Browse the repository at this point in the history
  • Loading branch information
jnussbaum committed Apr 15, 2024
1 parent c82749f commit a806f39
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -14,7 +14,7 @@ SBTX = ./sbtx
.PHONY: docs-build
docs-build: ## build docs into the local 'site' folder
@$(MAKE) -C docs graphvizfigures
mkdocs build
mkdocs build --strict

.PHONY: docs-serve
docs-serve: ## serve docs for local viewing
Expand Down
2 changes: 1 addition & 1 deletion docs/02-dsp-ontologies/knora-base.md
Expand Up @@ -603,7 +603,7 @@ There are two concrete subclasses of `kb:Segment`: `kb:AudioSegment` and `kb:Vid
`kb:VideoSegment` has the property `kb:isVideoSegmentOf`, which points to a [MovingImageRepresentation](#representations).
Both use the `kb:hasSegmentBounds` property directly.

It is possible to create subclases of `kb:AudoSegment` and `kb:VideoSegment` to add additional properties,
It is possible to create subclasses of `kb:AudioSegment` and `kb:VideoSegment` to add additional properties,
but this is discouraged and may not be supported in future versions of DSP-API.
Instead, instances of `kb:Annotation` pointing to the segment should be used to add additional information.

Expand Down
2 changes: 1 addition & 1 deletion docs/03-endpoints/api-v2/text/overview.md
Expand Up @@ -74,7 +74,7 @@ However, it does not allow for searching within the file content.

## TEI XML

All text values in DSP-API using stanodff markup can be converted to TEI XML as described [here](tei-xml.md).
All text values in DSP-API using standoff markup can be converted to TEI XML as described [here](tei-xml.md).

!!! info
Improved support for TEI XML is in planning.
5 changes: 2 additions & 3 deletions docs/05-internals/design/api-v2/how-to-add-a-route.md
Expand Up @@ -34,10 +34,9 @@ request message types by generating a `Future` containing a response message.
Add the path of your responder to the `org.knora.webapi.responders` package object,
and add code to `ResponderManager` to instantiate the new responder. Then add a `case` to
the `receive` method in `ResponderManager`, to match messages that extend your request
message trait, and pass them them to that responder's receive method.
message trait, and pass them to that responder's receive method.
The responder's resulting `Future` must be passed to the `ActorUtil.future2Message`.
See [Futures with Pekko](../principles/futures-with-pekko.md) and
[Error Handling](../principles/design-overview.md#error-handling) for details.
See [Error Handling](../principles/design-overview.md#error-handling) for details.

## Write a Route

Expand Down
2 changes: 0 additions & 2 deletions docs/05-internals/design/principles/design-overview.md
Expand Up @@ -94,8 +94,6 @@ actors. However, the design of reply message passing from actors (by
using `future2Message`), makes sure that any exceptions thrown inside
actors, will reach the route, where they will be handled.

See also [Futures with Akka](futures-with-pekko.md).

## API Routing

The API routes in the `routing` package are defined using the DSL
Expand Down
2 changes: 1 addition & 1 deletion justfile
Expand Up @@ -72,4 +72,4 @@ docs-serve: docs-build-dependent
mkdocs serve

docs-build: docs-build-dependent
mkdocs build
mkdocs build --strict

0 comments on commit a806f39

Please sign in to comment.