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
12 changes: 9 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,18 @@ jobs:

- name: Validate Marp presentation
run: |
mkdir -p site
mkdir -p site/ko site/en
npx --yes @marp-team/marp-cli@4 \
ai-agent-sandboxing.md \
ai-agent-sandboxing-ko.md \
--html \
--allow-local-files \
-o site/index.html
-o site/ko/index.html
npx --yes @marp-team/marp-cli@4 \
ai-agent-sandboxing-en.md \
--html \
--allow-local-files \
-o site/en/index.html
cp index.html site/index.html
cp -R assets site/assets

- name: Validate PowerShell syntax
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@
!.github/**

# Presentation source and referenced assets.
!ai-agent-sandboxing.md
!ai-agent-sandboxing-*.md
!assets/**
!docs/
!docs/**

# Generated GitHub Pages entrypoint.
index.html
# GitHub Pages language redirect.
!index.html

# PowerShell scripts and modules.
!*.ps1
Expand Down
34 changes: 22 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,47 @@
# Contributing

Thank you for improving the presentation materials, demo scripts, and
infrastructure definitions in this repository.
Thank you for improving the presentation materials, demo scripts, and infrastructure definitions in this repository.

## Development prerequisites

- Git
- Node.js 22 or later for Marp rendering
- PowerShell 7 for PowerShell scripts
- Bash for shell scripts
- PowerShell 7 for PowerShell scripts (Only for Windows users)
- Bash for shell scripts (Only for non-Windows users)
- Azure CLI with Bicep support for infrastructure validation

## Make a change

1. Create a branch using `feat/`, `fix/`, or `docs/`.
2. Keep generated HTML, PDF, PowerPoint, speaker-note exports, and previews
out of commits.
2. Keep generated HTML, PDF, PowerPoint, speaker-note exports, and previews out of commits.
3. Update `CHANGELOG.md` when a change affects users of the materials.
4. Use [Conventional Commits](https://www.conventionalcommits.org/) for commit
messages.
4. Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages.

## Validate presentation changes

```bash
# For English
mkdir -p en/assets
cp -R assets/. en/assets/
npx --yes @marp-team/marp-cli@4 \
ai-agent-sandboxing.md \
ai-agent-sandboxing-en.md \
--html \
--allow-local-files \
-o index.html
-o en/index.html
```

Review the generated presentation for overflow, broken image links, and
readability.
```bash
# For Korean
mkdir -p ko/assets
cp -R assets/. ko/assets/
npx --yes @marp-team/marp-cli@4 \
ai-agent-sandboxing-ko.md \
--html \
--allow-local-files \
-o ko/index.html
```

Review the generated presentation for overflow, broken image links, and readability.

## Validate scripts

Expand Down
52 changes: 44 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ The primary presentation was prepared for various conferences and meetups, and c
.
├── .github/
├── assets/
├── ai-agent-sandboxing.md # Marp presentation source
├── ai-agent-sandboxing-ko.md # Korean Marp presentation source
├── ai-agent-sandboxing-en.md # English Marp presentation source
├── docs/ # Demo setup, runbooks, and recovery guides
├── index.html # Generated presentation (ignored)
├── index.html # Redirect to the Korean presentation
├── LICENSE
└── README.md
```
Expand All @@ -29,29 +30,64 @@ The [demo documentation index](docs/README.md) provides two complete, sequential

## Preview the presentation

1. Install Node.js 22 or later, then generate an HTML presentation:
> [!NOTE]
> To preview the presentation, you'll need 3 terminals.

1. Install Node.js 22 or later

1. Generate an HTML presentation for English in Terminal A:

```bash
# zsh/bash
mkdir -p en/assets
cp -R assets/. en/assets/
npx --yes @marp-team/marp-cli@4 \
--watch \
ai-agent-sandboxing-en.md \
--html \
--allow-local-files \
-o en/index.html
```

```powershell
# PowerShell
New-Item -ItemType Directory -Force en/assets
Copy-Item -Recurse -Force assets/* en/assets/
npx --yes @marp-team/marp-cli@4 `
--watch `
ai-agent-sandboxing-en.md `
--html `
--allow-local-files `
-o en/index.html
```

1. Generate an HTML presentation for Korean in Terminal B:

```bash
# zsh/bash
mkdir -p ko/assets
cp -R assets/. ko/assets/
npx --yes @marp-team/marp-cli@4 \
--watch \
ai-agent-sandboxing.md \
ai-agent-sandboxing-ko.md \
--html \
--allow-local-files \
-o index.html
-o ko/index.html
```

```powershell
# PowerShell
New-Item -ItemType Directory -Force ko/assets
Copy-Item -Recurse -Force assets/* ko/assets/
npx --yes @marp-team/marp-cli@4 `
--watch `
ai-agent-sandboxing.md `
ai-agent-sandboxing-ko.md `
--html `
--allow-local-files `
-o index.html
-o ko/index.html
```

1. Run local web server:
1. Run local web server in Terminal C:

```bash
npx serve .
Expand Down
Loading