Skip to content

Add Zensical documentation site with GitHub Pages#12

Merged
MISBMS merged 2 commits intomainfrom
docs
Apr 13, 2026
Merged

Add Zensical documentation site with GitHub Pages#12
MISBMS merged 2 commits intomainfrom
docs

Conversation

@tshan10
Copy link
Copy Markdown
Collaborator

@tshan10 tshan10 commented Apr 12, 2026

Summary

Adds a full documentation site for DLM using [Zensical] with automated build and deployment to GitHub Pages.

What's included

Documentation site (docs/)

  • Home — architecture overview, mermaid sequence diagram of the lock flow, key features, lock identity scoping, lifecycle
  • Getting Started — Java 17 requirement, Maven dependency, build instructions, Testcontainers note, minimal end-to-end example
  • Usage — builder parameter table, tabbed Aerospike/HBase init examples, all API overloads (tryAcquireLock, acquireLock, releaseLock), defaults table, error handling with switch on ErrorCode, complete lifecycle example, cleanup/destroy() section
  • Locking Semantics — lock level key formats (DC#farmId#lockId, XDC#lockId), lock modes, full API reference tables, retry flowchart, error codes reference, exception propagation, thread safety notes
  • Aerospike Backend — generation-based locking explanation, write policy details, set naming, retry behavior (guava-retrying), bin layout, initialization/cleanup
  • HBase BackendcheckAndMutate locking, auto table creation with pre-split, TTL behavior, row key hash-prefix distribution, column layout, initialization/cleanup

CI/CD (.github/workflows/docs.yml)

  • PR buildspr-build-check job validates docs on every pull request (build only, no deploy)
  • Deploy on push to main — builds and deploys to GitHub Pages via actions/deploy-pages
  • Concurrency guardpages-${{ github.ref }} group with cancel-in-progress: true to prevent racing deployments

@tshan10 tshan10 requested a review from MISBMS April 12, 2026 13:11
@sonarqubecloud
Copy link
Copy Markdown

@MISBMS MISBMS merged commit b1e5103 into main Apr 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants