Open
Conversation
Implements GitHub issue #40 - generates markdown documentation from Go config structs using go/ast parsing. Features: - Parses Go source files to extract struct definitions, field types, yaml tags, and doc comments - Generates markdown tables with field name, YAML key, type, required status, and description - Adds comprehensive doc comments to all provider config structs - Adds `make docs` target for easy regeneration Generated docs cover: - Core configuration (project name, provider, domain, certificates) - AWS provider (EKS, VPC, node groups, EFS) - GCP provider (GKE, VPC, node pools, GPUs) - Azure provider (AKS, networking, node pools) - Local provider (K3s, kind, minikube) - Cloudflare DNS provider - Git repository configuration for ArgoCD
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes
Closes #40
Description
Adds a documentation generator (
cmd/docgen) that parses Go config structs usinggo/astand generates markdown documentation. Also adds comprehensive doc comments to all provider config structs.New files:
cmd/docgen/- Documentation generator with full test coveragedocs/configuration/- Auto-generated markdown docsUpdated files:
Makefile- AddeddocstargetREADME.mdanddocs/README.md- Added Configuration Reference sectionsHow to Test
make docsto regenerate documentationgo test ./cmd/docgen/...to verify tests passdocs/configuration/for generated markdown files