ArcadeDB Documentation

Generate html and pdf documentation:

mvn generate-resources

Tip: You can build the documentation without installing Maven locally by using Docker:

docker run --rm -v "$PWD":/docs -w /docs maven:3.8.8 mvn generate-resources

Documentation is generated under target/generated-docs folder

Serve documentation on local http server:

mvn jetty:run

Tip: You can also serve the documentation using Docker without installing Maven:

docker run --rm -it -p 8080:8080 -v "$PWD":/docs -w /docs maven:3.8.8 mvn jetty:run

Then open your browser to http://localhost:8080

then open the browser to http://localhost:8080

Documentation Conventions

To maintain consistency across the documentation, please follow these naming conventions:

File Naming Conventions

All documentation files should use lowercase naming with hyphens between words:

• ✅ lowercase-with-hyphens.adoc
• ❌ CamelCase.adoc
• ❌ UPPERCASE.adoc
• ❌ snake_case.adoc

Document ID Anchors

Document anchors should also use lowercase with hyphens:

[[anchor-id-example]]
== Section…