fix: create script to generate config doc

[zhumin8]

Add script to generate a doc/config-schema.md that describes config schema based off internal/config/config.go and other referenced configs. Ordered to list Structs from config.go at the top, and others alphabetically.

This tool must be package main to provide the entry point for the Go compile, as it's purpose is to be "run" (either manually or via go generate).

Manual verification:
The documentation can be regenerated using the standard Go generate tool:
go generate ./internal/config/...

Alternatively, for manual runs from the root:
go run -tags configdocgen cmd/config_doc_generate.go

Fix #3681

[gemini-code-assist]

Code Review

This pull request introduces a script to automatically generate documentation for the librarian.yaml configuration schema, which is a great addition for maintainability. The script parses the Go structs in internal/config and produces a markdown file.

My review focuses on improving the robustness and performance of the new generator script, in line with the TODO to clean up the logic. I've suggested two main changes:

• Making the logic for identifying internal structs more reliable by using the parsed struct map instead of a name-based heuristic.
• Improving performance by pre-compiling a regular expression.

These changes will make the generator more accurate and efficient. The generated documentation itself looks good and will be a valuable resource.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.78%. Comparing base (241bbc3) to head (419f09d).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3721      +/-   ##
==========================================
+ Coverage   82.43%   82.78%   +0.35%     
==========================================
  Files         138      138              
  Lines       12758    13038     +280     
==========================================
+ Hits        10517    10794     +277     
- Misses       1747     1751       +4     
+ Partials      494      493       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[zhumin8]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces a valuable script to automatically generate configuration schema documentation from Go source files, which will help keep documentation synchronized with the code. The implementation is solid and includes a good set of unit tests. My review includes a high-severity fix for a bug in markdown link generation for embedded structs, along with a medium-severity suggestion to improve error handling.

[miguelvelezsa]

Also would be great if you can create several files to split the logic you are adding 😃

[zhumin8]

Thanks @miguelvelezsa for your reviews!

Also would be great if you can create several files to split the logic you are adding 😃

I'd prefer to keep this code in one file, at least for now: 1)this is an internal tool for generating one specific doc file, it is more self-contained, and less likely for its code to be reused in other parts of the project. 2) it is relatively a small tool not too hard to read (I hope) at the moment.