docs: adds package description to the stdlib Index

Signed-off-by: Sam Alba <sam.alba@gmail.com>

cmd/dagger/cmd/doc.go

@@ -407,6 +407,7 @@ func walkStdlib(ctx context.Context, output, format string) {
 	// Generate index from sorted list of packages
 	sort.Strings(indexKeys)
 	for _, p := range indexKeys {
-		fmt.Fprintf(index, "- [%s](./%s)\n", p, getFileName(p))
+		description := mdEscape(packages[p].Description)
+		fmt.Fprintf(index, "- [%s](./%s) - %s\n", p, getFileName(p), description)
 	}
 }

docs/reference/universe/README.md

@@ -1,28 +1,28 @@
 # Index
 
-- [alpine](./alpine.md)
+- [alpine](./alpine.md) - Base package for Alpine Linux
-- [aws](./aws/README.md)
+- [aws](./aws/README.md) - AWS base package
-- [aws/cloudformation](./aws/cloudformation.md)
+- [aws/cloudformation](./aws/cloudformation.md) - AWS CloudFormation
-- [aws/ecr](./aws/ecr.md)
+- [aws/ecr](./aws/ecr.md) - Amazon Elastic Container Registry (ECR)
-- [aws/ecs](./aws/ecs.md)
+- [aws/ecs](./aws/ecs.md) - AWS Elastic Container Service (ECS)
-- [aws/eks](./aws/eks.md)
+- [aws/eks](./aws/eks.md) - AWS Elastic Kubernetes Service (EKS)
-- [aws/elb](./aws/elb.md)
+- [aws/elb](./aws/elb.md) - AWS Elastic Load Balancer (ELBv2)
-- [aws/rds](./aws/rds.md)
+- [aws/rds](./aws/rds.md) - AWS Relational Database Service (RDS)
-- [aws/s3](./aws/s3.md)
+- [aws/s3](./aws/s3.md) - AWS Simple Storage Service
-- [dagger](./dagger/README.md)
+- [dagger](./dagger/README.md) - Dagger core types
-- [dagger/op](./dagger/op.md)
+- [dagger/op](./dagger/op.md) - op: low-level operations for Dagger processing pipelines
-- [docker](./docker.md)
+- [docker](./docker.md) - Docker container operations
-- [gcp](./gcp/README.md)
+- [gcp](./gcp/README.md) - Google Cloud Platform
-- [gcp/gcr](./gcp/gcr.md)
+- [gcp/gcr](./gcp/gcr.md) - Google Container Registry
-- [gcp/gke](./gcp/gke.md)
+- [gcp/gke](./gcp/gke.md) - Google Kubernetes Engine
-- [git](./git.md)
+- [git](./git.md) - Git operations
-- [go](./go.md)
+- [go](./go.md) - Go build operations
-- [io](./io.md)
+- [io](./io.md) - IO operations
-- [js/yarn](./js/yarn.md)
+- [js/yarn](./js/yarn.md) - Yarn is a package manager for Javascript applications
-- [kubernetes](./kubernetes/README.md)
+- [kubernetes](./kubernetes/README.md) - Kubernetes client operations
-- [kubernetes/helm](./kubernetes/helm.md)
+- [kubernetes/helm](./kubernetes/helm.md) - Helm package manager
-- [kubernetes/kustomize](./kubernetes/kustomize.md)
+- [kubernetes/kustomize](./kubernetes/kustomize.md) - Kustomize config management
-- [netlify](./netlify.md)
+- [netlify](./netlify.md) - Netlify client operations
-- [os](./os.md)
+- [os](./os.md) - OS operations
-- [random](./random.md)
+- [random](./random.md) - Random generation utilities
-- [terraform](./terraform.md)
+- [terraform](./terraform.md) - Terraform operations

docs/reference/universe/dagger/README.md

@@ -4,6 +4,8 @@ sidebar_label: dagger
 
 # dagger.io/dagger
 
+Dagger core types
+
 ```cue
 import "dagger.io/dagger"
 ```

docs/reference/universe/os.md

@@ -4,6 +4,8 @@ sidebar_label: os
 
 # dagger.io/os
 
+OS operations
+
 ```cue
 import "dagger.io/os"
 ```

stdlib/dagger/dagger.cue

@@ -1,3 +1,4 @@
+// Dagger core types
 package dagger
 
 import (

stdlib/os/file.cue

@@ -1,3 +1,4 @@
+// OS operations
 package os
 
 import (