laskoviymishka opened a new pull request, #920:
URL: https://github.com/apache/iceberg-go/pull/920
Introduces website/gen, a small stdlib-only program that walks the repo for
example_*_test.go files carrying an `iceberg:doc` header and regenerates the
Concepts section of the mdbook site from them. Code blocks will be emitted as
mdbook `{{#include file:anchor}}` directives, so the compiled test, not a
hand-maintained snippet, is the source of truth for each example.
No test file carries the header yet, so the generator is a no-op at this
point; it exits 0 with a log line.
This PR is more a question - should we already automate generation of docs?
cc @zeroshade / @kevinjqliu.
If yes - after merge i'll do a follow-up PR will anchor the existing
examples, add the SUMMARY marker block, commit the first generated page, and
wire the CI gate.
Adds a `docs-gen` Makefile target so `make docs-gen` regenerates the
concepts in one command.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
