/docs-sdk-scala

Initial Scala SDK docs during development of the 3.0 SDK API. Will be: The Scala SDK documentation source files to be used in the new Couchbase Docs site. https://docs.couchbase.com

Primary LanguageScalaApache License 2.0Apache-2.0

docs-sdk-scala

Documentation for the Couchbase Scala SDK.

Contributions

Contributions are welcome! Please test them locally (see below) and then submit a pull request.

Testing changes locally

The documentation system Antora is used to build the docs.

Install Antora 2, then:

antora staging-antora-playbook.yml

The generated HTML is written to public.

Note that, as these docs are intended to be built as part of a wider documentation set, there will be a number of errors both to stdout and in the generated output. As long as these appear to relate to outside packages, they can be safely ignored.