Skip to content

fix(deploy): handle protocol/standards split layout from 0xMiden/protocol #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mmagician wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(deploy): handle protocol/standards split layout from 0xMiden/protocol #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ jobs:
echo "Aggregating vendor docs into v0.4 IA structure..."

# Clean directories that will be re-synced (v0.4 nested paths)
rm -rf docs/core-concepts/protocol docs/core-concepts/miden-vm docs/core-concepts/node docs/core-concepts/compiler
rm -rf docs/core-concepts/protocol docs/core-concepts/standards docs/core-concepts/miden-vm docs/core-concepts/node docs/core-concepts/compiler
# tools/clients: only clean ingested subdirs; preserve locally-authored web-client/, react-sdk/, index.md
rm -rf docs/builder/tools/clients/rust-client
rm -rf docs/builder/tools/clients/img
Expand All @@ -169,10 +169,24 @@ jobs:
rm -rf docs/builder/tutorials/recipes/img

# Core Concepts docs → docs/core-concepts/*
if [ -d "vendor/protocol/docs/src" ]; then
# 0xMiden/protocol switched its docs/src layout to a split:
# docs/src/protocol/ → docs/core-concepts/protocol/
# docs/src/standards/ → docs/core-concepts/standards/
# Released versions (e.g. v0.14.x) still ship the flat layout, so
# fall back to the legacy ingest if no protocol/ subdir is present.
if [ -d "vendor/protocol/docs/src/protocol" ]; then
mkdir -p docs/core-concepts/protocol
cp -r vendor/protocol/docs/src/* docs/core-concepts/protocol/
cp -r vendor/protocol/docs/src/protocol/. docs/core-concepts/protocol/
echo "Synced protocol → docs/core-concepts/protocol"
if [ -d "vendor/protocol/docs/src/standards" ]; then
mkdir -p docs/core-concepts/standards
cp -r vendor/protocol/docs/src/standards/. docs/core-concepts/standards/
echo "Synced standards → docs/core-concepts/standards"
fi
elif [ -d "vendor/protocol/docs/src" ]; then
mkdir -p docs/core-concepts/protocol
cp -r vendor/protocol/docs/src/* docs/core-concepts/protocol/
echo "Synced protocol (legacy flat layout) → docs/core-concepts/protocol"
fi

if [ -d "vendor/miden-vm/docs/src" ]; then
Expand Down
Loading