This repository contains the documentation website code and Markdown source files for docs.aklivity.io/zilla/.
Before submitting your contribution, please read through the following guide. We also suggest you read the Writing Guide in this repo.
To develop locally, fork this repository and clone it in your local machine. Then run these commands from the root directory:
pnpm i
pnpm dev
Markdown linting
run:
pnpm lint
Spelling, grammar, and style lints
Install Vale then run:
vale src
vale --ignore-syntax src/.vuepress/sidebar/en.ts
Link checking
Install Lychee then run:
lychee --exclude-mail src
Running compiled site link checking:
pnpm link-checker && lychee --exclude-mail --base="src/.vuepress/dist" src/.vuepress/dist
Pages in the reference section describe, as briefly as possible and in an orderly way, the properties and interface of a feature.
#### parent.child
[]
only when describing child properties#### parentArray[].child
\*
at the end of the header and ToC link
### topLevelProp\*
# Title
Description.
```yaml
topLevelProp:
child: example
array:
- one
- two
parentArray:
- child: one
- child: two
:::: note ToC
::: right * required :::
::::
object
Description.
topLevelProp:
child: example
type
| Default:value
Description.
array
ofprimitive
Description.
array:
- one
- two
array
ofobject
Description.
parentArray:
- child: one
- child: two
type
Description.
### Generate schema asset
capture the output and delete the first and last lines
```bash
docker run -it --rm -e ZILLA_INCUBATOR_ENABLED=true ghcr.io/aklivity/zilla:latest start -v -Pzilla.engine.verbose.schema > src/.vuepress/public/assets/zilla-schema.json
pnpm check-schema > schema-edits.txt
We’d love to hear your feedback. Please file documentation issues only in the docs GitHub repository. You can file a new issue to suggest improvements or if you see any errors in the existing documentation.
Every page has an Edit this page on GitHub
link at the bottom for you to check the page source and report specific issues.
Copyright Aklivity, Inc. 2024, released under the Apache 2.0 license.