mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-04 20:17:09 +00:00
chore(docs): replace d2 diagram pipeline with mermaid
Remove docs/_diagrams/ and d2 build step from Makefile. The HTML template already initialises mermaid.js; diagrams are now inline code fences rendered client-side.
This commit is contained in:
1 parent
af7b7e27b0
commit
951a548109
2 files changed
+2
-73
No files matched your search
@@ -14,8 +14,6 @@ SANDERLING_BIN := bin/sanderling
|
|||||||
DOCS_SRC := $(shell find docs -type f -name '*.md' -not -path 'docs/_*')
|
DOCS_SRC := $(shell find docs -type f -name '*.md' -not -path 'docs/_*')
|
||||||
DOCS_OUT := $(patsubst docs/%.md,build/site/%.html,$(DOCS_SRC))
|
DOCS_OUT := $(patsubst docs/%.md,build/site/%.html,$(DOCS_SRC))
|
||||||
DOCS_TEMPLATE := docs/_template/page.html
|
DOCS_TEMPLATE := docs/_template/page.html
|
||||||
DIAGRAM_SRC := $(shell find docs/_diagrams -type f -name '*.d2' 2>/dev/null)
|
|
||||||
DIAGRAM_OUT := $(patsubst docs/_diagrams/%.d2,build/site/_assets/diagrams/%.svg,$(DIAGRAM_SRC))
|
|
||||||
|
|
||||||
INSPECT_DIST := internal/inspect/dist
|
INSPECT_DIST := internal/inspect/dist
|
||||||
WEB_DIST := inspect-ui/dist
|
WEB_DIST := inspect-ui/dist
|
||||||
@@ -84,18 +82,14 @@ test-kotlin:
|
|||||||
test-spec-api:
|
test-spec-api:
|
||||||
cd pkg/spec && npm test --silent
|
cd pkg/spec && npm test --silent
|
||||||
|
|
||||||
docs: $(DOCS_OUT) build/site/_assets $(DIAGRAM_OUT)
|
docs: $(DOCS_OUT) build/site/_assets
|
||||||
@echo "built $(words $(DOCS_OUT)) pages, $(words $(DIAGRAM_OUT)) diagrams to build/site"
|
@echo "built $(words $(DOCS_OUT)) pages to build/site"
|
||||||
|
|
||||||
build/site/_assets: docs/_assets
|
build/site/_assets: docs/_assets
|
||||||
@mkdir -p build/site
|
@mkdir -p build/site
|
||||||
@rm -rf $@
|
@rm -rf $@
|
||||||
@cp -R $< $@
|
@cp -R $< $@
|
||||||
|
|
||||||
build/site/_assets/diagrams/%.svg: docs/_diagrams/%.d2
|
|
||||||
@mkdir -p $(dir $@)
|
|
||||||
@d2 --theme 301 --pad 20 $< $@
|
|
||||||
|
|
||||||
build/site/%.html: docs/%.md $(DOCS_TEMPLATE)
|
build/site/%.html: docs/%.md $(DOCS_TEMPLATE)
|
||||||
@mkdir -p $(dir $@)
|
@mkdir -p $(dir $@)
|
||||||
@pandoc $< --from=gfm --to=html5 --standalone \
|
@pandoc $< --from=gfm --to=html5 --standalone \
|
||||||
|
|||||||
@@ -1,65 +0,0 @@
|
|||||||
grid-rows: 2
|
|
||||||
grid-gap: 40
|
|
||||||
|
|
||||||
test_run: {
|
|
||||||
label: "Test run"
|
|
||||||
grid-rows: 2
|
|
||||||
grid-gap: 100
|
|
||||||
|
|
||||||
go_binary: sanderling (Go) {
|
|
||||||
direction: right
|
|
||||||
|
|
||||||
bundler: Bundler\nesbuild
|
|
||||||
verifier: Verifier\ngoja + LTL
|
|
||||||
runner: Runner
|
|
||||||
driver: Driver
|
|
||||||
trace: Trace writer\nJSONL + PNG
|
|
||||||
|
|
||||||
bundler -> verifier
|
|
||||||
verifier <-> runner
|
|
||||||
runner -> driver
|
|
||||||
runner -> trace
|
|
||||||
}
|
|
||||||
|
|
||||||
platform: {
|
|
||||||
label: ""
|
|
||||||
direction: right
|
|
||||||
style.stroke-width: 0
|
|
||||||
style.fill: transparent
|
|
||||||
|
|
||||||
device: Emulator / device {
|
|
||||||
sdk: sanderling-sdk\npause / state\ncoverage / logs
|
|
||||||
}
|
|
||||||
|
|
||||||
sidecar: Maestro sidecar (JVM) {
|
|
||||||
maestro: maestro-client
|
|
||||||
}
|
|
||||||
|
|
||||||
sidecar.maestro -> device.sdk: UIAutomator
|
|
||||||
}
|
|
||||||
|
|
||||||
go_binary.driver -> platform.sidecar.maestro: gRPC
|
|
||||||
go_binary.runner -> platform.device.sdk: Unix socket
|
|
||||||
}
|
|
||||||
|
|
||||||
viewer: {
|
|
||||||
label: "Inspect"
|
|
||||||
grid-columns: 4
|
|
||||||
grid-gap: 40
|
|
||||||
|
|
||||||
left_pad: "" {
|
|
||||||
style.stroke-width: 0
|
|
||||||
style.fill: transparent
|
|
||||||
style.opacity: 0
|
|
||||||
}
|
|
||||||
web: Web UI (React)
|
|
||||||
inspect: sanderling inspect\nHTTP + SSE
|
|
||||||
runs: runs/ {
|
|
||||||
shape: cylinder
|
|
||||||
}
|
|
||||||
|
|
||||||
runs -> inspect
|
|
||||||
inspect -> web
|
|
||||||
}
|
|
||||||
|
|
||||||
test_run.go_binary.trace -> viewer.runs
|
|
||||||
Reference in new issue
Block a user