Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,32 @@ python -m venv ~/.venvs/zensical
source ~/.venvs/zensical/bin/activate
pip install zensical
```
### Preview site locally
Once installed, activate the venv and run Zensical from the repository root:
### Running Zensical

Once installed, either activate the venv or run the binary directly:

```bash
# Option 1: Activate the venv
source ~/.venvs/zensical/bin/activate

# Live preview with hot-reload
zensical serve

# Production build
zensical build --clean
# Option 2: Run directly without activating
~/.venvs/zensical/bin/zensical serve
```

Common commands:

- `zensical serve` — live preview with hot-reload
- `zensical build --clean` — production build
- Review build output for broken link warnings

### Adding New Pages

1. Create the markdown file in `docs/`
2. Add the page to the nav section in `zensical.toml`
3. Create corresponding code examples in all three languages under `examples/`
4. Test locally with `zensical serve`

## Vendored dependencies

The Zensical theme lazy-loads a few third-party assets (Mermaid for diagrams,
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# AWS Lambda durable functions developer documentation source
# AWS Lambda durable execution developer documentation source

This repository contains the source for the AWS Lambda Durable Execution SDK
documentation website at https://docs.aws.amazon.com/durable-execution,
providing comprehensive guides and references for building resilient,
documentation website at https://docs.aws.amazon.com/durable-execution, providing comprehensive guides and references for building resilient,
long-running applications with AWS Lambda durable functions across
multiple programming languages.

Expand Down Expand Up @@ -40,10 +39,9 @@ pip install zensical
zensical serve
```

For the full authoring workflow — adding code samples, formatting conventions,
commit messages, and pull request process — see
[CONTRIBUTING.md](CONTRIBUTING.md). For Markdown formatting syntax, please see
the [Authoring Guide](authoring-guide.md).
For the full authoring workflow, please see [CONTRIBUTING.md](CONTRIBUTING.md).

For writing style and Markdown formatting syntax, please see the [Authoring Guide](authoring-guide.md).

## Kiro Power

Expand All @@ -64,6 +62,7 @@ for details.
- [AWS Lambda durable functions Documentation](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html)
- [JavaScript SDK Repository](https://github.com/aws/aws-durable-execution-sdk-js)
- [Python SDK Repository](https://github.com/aws/aws-durable-execution-sdk-python)
- [Java SDK Repository](https://github.com/aws/aws-durable-execution-sdk-java)

## Feedback & Support

Expand Down
Loading