feat: config docs generator

[Jiloc]

Description

Dpn't be too scared! Many of the line changes are due to the final Markdown, the updated comments (already in review in #6168) and the tests!

This PR introduces a new workspace member, config-docs-generator, a tool designed to automatically generate Markdown documentation for Stacks node TOML configuration options. The documentation is extracted directly from Rust source code comments, primarily from stackslib/src/config/mod.rs and other specified locations.

The config-docs-generator consists of two main binaries:

1. extract-docs: This binary uses cargo +nightly rustdoc --output-format json to generate documentation in JSON format. It then parses this JSON to extract structured documentation for specified configuration structs, including descriptions, default values (resolving constant references across crates), notes, deprecation messages, and TOML examples.
2. generate-markdown: This binary takes the JSON output from extract-docs and converts it into a comprehensive Markdown file (docs/generated/configuration-reference.md), complete with a table of contents and cross-references.

A shell script, contrib/tools/config-docs-generator/generate-config-docs.sh, orchestrates the building of these tools and the entire documentation generation pipeline.

A Dockerfile builds the config-docs-generator tools and sets its entrypoint to generate-config-docs.sh. This allows for generating configuration documentation in a consistent, containerized environment.

Applicable issues

• seventh! step of Document config.toml options automatically #5898 - we are almost there!

Additional info (benefits, drawbacks, caveats)

Benefits:

• Ensures configuration documentation is always up-to-date and directly reflects the source code, reducing the likelihood of documentation drift.
• Automates the documentation process, reducing manual effort in maintaining it.
• Provides users with a clear, consistent, and comprehensive reference for all node configuration options.

Drawbacks/Caveats:

• The extract-docs tool relies on the nightly rustdoc JSON output format (-Z unstable-options --output-format json)

Checklist

• Test coverage for new or modified code paths
• Changelog is updated
• Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
• New clarity functions have corresponding PR in clarity-benchmarking repo
• New integration test(s) added to bitcoin-tests.yml

[codecov]

Codecov Report

Attention: Patch coverage is 99.46588% with 9 lines in your changes missing coverage. Please review.

Project coverage is 83.70%. Comparing base (28fc444) to head (826c7cc).
Report is 6 commits behind head on develop.

Files with missing lines	Patch %	Lines
...ols/config-docs-generator/src/generate_markdown.rs	99.12%	9 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6171      +/-   ##
===========================================
+ Coverage    83.42%   83.70%   +0.27%     
===========================================
  Files          546      549       +3     
  Lines       392583   396519    +3936     
  Branches       323      323              
===========================================
+ Hits        327531   331901    +4370     
+ Misses       65044    64610     -434     
  Partials         8        8              

Files with missing lines	Coverage Δ
...ib/tools/config-docs-generator/src/extract_docs.rs	96.00% <ø> (ø)
...b/tools/config-docs-generator/tests/integration.rs	100.00% <100.00%> (ø)
...ols/config-docs-generator/src/generate_markdown.rs	99.12% <99.12%> (ø)

... and 52 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 28fc444...826c7cc. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rdeioris]

I definitely love it, I would just make it less "hardcoded" (see my comments)

[wileyj]

some structure changes are needed - duplicate changes as #6168, and the produced markdown sholdn't be commited (but should be auto-generated)

[wileyj]

lgtm

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.