Merge pull request #6171 from Jiloc/feat/config-docs-generator

feat: config docs generator

Author: Jiloc

.gitignore

@@ -61,6 +61,7 @@ testnet/index.html
 /testnet/helium/target/
 /contrib/tools/puppet-chain/target/
 /contrib/core-contract-tests/.cache/
+/contrib/tools/config-docs-generator/target/
 
 # These are backup files generated by rustfmt
 **/*.rs.bk

Cargo.lock

@@ -9,7 +9,8 @@ members = [
     "libstackerdb",
     "libsigner",
     "stacks-signer",
-    "testnet/stacks-node"]
+    "testnet/stacks-node",
+    "contrib/tools/config-docs-generator"]
 
 # Dependencies we want to keep the same between workspace members
 [workspace.dependencies]

Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+name = "config-docs-generator"
+version = "0.1.0"
+edition = "2024"
+
+[[bin]]
+name = "extract-docs"
+path = "src/extract_docs.rs"
+
+[[bin]]
+name = "generate-markdown"
+path = "src/generate_markdown.rs"
+
+# Add integration test configuration
+[[test]]
+name = "integration"
+path = "tests/integration.rs"
+
+[dependencies]
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+clap = { version = "4.0", features = ["derive"] }
+regex = "1.0"
+anyhow = "1.0"
+once_cell = "1.18"
+
+# Add test dependencies
+[dev-dependencies]
+tempfile = "3.0"
+assert_cmd = "2.0"

contrib/tools/config-docs-generator/Cargo.toml

@@ -0,0 +1,38 @@
+# Use a specific nightly toolchain for reproducible builds
+FROM rustlang/rust@sha256:04690ffa09cddd358b349272173155319f384e57816614eea0840ec7f9422862
+
+RUN apt-get update -y \
+ && apt-get install -y --no-install-recommends \
+    jq \
+ && rm -rf /var/lib/apt/lists/*
+
+# Set the working directory for building
+WORKDIR /build
+
+# Copy the entire project root to preserve structure
+# Copy from three levels up (project root) to maintain the directory structure
+COPY ../../../ /build
+
+RUN useradd -ms /bin/bash docs-builder
+RUN chown docs-builder -R /build
+USER docs-builder
+
+# Pre-build the config-docs-generator binaries during image build
+RUN cargo build --package config-docs-generator --release
+
+# Set the working directory where the project will be mounted at runtime
+WORKDIR /project_root
+
+# Set environment variables for generate-config-docs.sh
+ENV PROJECT_ROOT=/project_root \
+    CARGO_TARGET_DIR=/tmp/stacks-config-docs/target \
+    TEMP_DIR=/tmp/stacks-config-docs/doc-generation \
+    EXTRACT_DOCS_BIN=/build/target/release/extract-docs \
+    GENERATE_MARKDOWN_BIN=/build/target/release/generate-markdown \
+    OUTPUT_DIR=/project_root/target/generated-docs \
+    SKIP_BUILD=true
+
+# Create the Docker-specific temp directory
+RUN mkdir -p /tmp/stacks-config-docs
+
+ENTRYPOINT ["/build/generate-config-docs.sh"]