From df8b9fd5b4915b16cdba732076f377689b23d647 Mon Sep 17 00:00:00 2001 From: Toby Hede Date: Wed, 12 Nov 2025 10:25:00 +1100 Subject: [PATCH] fix(docs): include markdown and XML in package archives Updated package.sh to include all three documentation formats: - markdown/API.md - xml/*.xml - html/ Previously only packaged the html/ directory. Now archives contain complete documentation set suitable for distribution. --- tasks/docs/package.sh | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/tasks/docs/package.sh b/tasks/docs/package.sh index 70bb3491..81ed50e0 100755 --- a/tasks/docs/package.sh +++ b/tasks/docs/package.sh @@ -16,12 +16,20 @@ if [ ! -f "${DOCS_DIR}/html/index.html" ]; then exit 1 fi -# Validate documentation directory has content -if [ ! -d "${DOCS_DIR}/html" ] || [ -z "$(ls -A ${DOCS_DIR}/html)" ]; then - echo "Error: ${DOCS_DIR}/html is empty or does not exist" +if [ ! -f "${DOCS_DIR}/markdown/API.md" ]; then + echo "Error: ${DOCS_DIR}/markdown/API.md not found" + echo "Run 'mise run docs:generate:markdown' first to generate markdown documentation" exit 1 fi +if [ ! -d "${DOCS_DIR}/xml" ] || [ -z "$(ls -A ${DOCS_DIR}/xml/*.xml 2>/dev/null)" ]; then + echo "Error: ${DOCS_DIR}/xml/*.xml files not found" + echo "Run 'mise run docs:generate' first to generate XML documentation" + exit 1 +fi + + + # Create output directory mkdir -p "${OUTPUT_DIR}" @@ -29,12 +37,12 @@ mkdir -p "${OUTPUT_DIR}" echo "Creating archives..." cd "${DOCS_DIR}" -# Create ZIP archive -zip -r -q "../../${OUTPUT_DIR}/eql-docs-${VERSION}.zip" html/ +# Create ZIP archive with all documentation formats +zip -r -q "../../${OUTPUT_DIR}/eql-docs-${VERSION}.zip" markdown/API.md xml/*.xml html/ echo "Created ${OUTPUT_DIR}/eql-docs-${VERSION}.zip" -# Create tarball -tar czf "../../${OUTPUT_DIR}/eql-docs-${VERSION}.tar.gz" html/ +# Create tarball with all documentation formats +tar czf "../../${OUTPUT_DIR}/eql-docs-${VERSION}.tar.gz" markdown/API.md xml/ html/ echo "Created ${OUTPUT_DIR}/eql-docs-${VERSION}.tar.gz" cd ../..