Markdown Docs that can be fetched

cmd/oss-api/main.go

@@ -48,6 +48,7 @@ func initTracer(ctx context.Context, res *sdkresource.Resource) (*sdktrace.Trace
 	return tp, nil
 }
 
+
 func main() {
 	isEndpointProvided := os.Getenv("OTEL_EXPORTER_OTLP_ENDPOINT") != "" ||
 		os.Getenv("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT") != ""

go.mod

@@ -16,6 +16,7 @@ require (
 	go.temporal.io/api v1.50.0
 	go.temporal.io/sdk v1.34.0
 	google.golang.org/protobuf v1.36.6
+	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (

internal/docs/code_change/markdown_handler.md

@@ -0,0 +1,11 @@
+---
+title: "Code Change Metrics"
+---
+The Code Change engineering metric quantifies the team’s weekly development activity by measuring the total number of lines of code added, modified, or deleted across our repositories.
+
+* **Source**: Computed from commit diffs in our Git version-control system, excluding merge commits and auto-generated files.
+* **Aggregation**: Grouped by ISO week (Monday–Sunday).
+* **Purpose**:
+   * Tracks engineering velocity and throughput over time.
+   * Highlights spikes (e.g., major feature work or refactors) and troughs (e.g., stabilization periods, planning, or holidays).
+   * Helps correlate process changes (code freezes, new tooling) with fluctuations in developer output.

internal/docs/commits/markdown_handler.md

@@ -0,0 +1,3 @@
+---
+title: "Commits Metrics"
+---

internal/docs/deploy_freq/markdown_handler.md

@@ -0,0 +1,3 @@
+---
+title: "Deploy Frequency Metrics"
+---

internal/docs/embed.go

@@ -0,0 +1,10 @@
+package docs
+
+import "embed"
+
+//go:embed */*.md
+var DocsFS embed.FS
+
+type MarkdownHandlerFrontmatter struct {
+	Title string `yaml:"title"`
+}

internal/docs/merge_freq/markdown_handler.md

@@ -0,0 +1,3 @@
+---
+title: "Merge Frequency Metrics"
+---

internal/docs/mr_opened/markdown_handler.md

@@ -0,0 +1,3 @@
+---
+title: "Merge Frequency Metrics"
+---

internal/oss-api/handler/code_chage.go

@@ -5,6 +5,7 @@ import (
 	"net/http"
 
 	"github.com/dxta-dev/app/internal/data"
+	"github.com/dxta-dev/app/internal/docs"
 	"github.com/dxta-dev/app/internal/markdown"
 	api "github.com/dxta-dev/app/internal/oss-api"
 	"github.com/dxta-dev/app/internal/util"
@@ -39,17 +40,19 @@ func CodeChangeMarkdownHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	meta, body, err := util.ReadMarkdownFromFS[docs.MarkdownHandlerFrontmatter](
+		docs.DocsFS,
+		"code_change/markdown_handler.md",
+	)
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
 	m, err := markdown.GetAggregatedValuesMarkdown(
 		ctx,
-		"Code Change Metrics",
-		`The Code Change engineering metric quantifies the team’s weekly development activity by measuring the total number of lines of code added, modified, or deleted across our repositories.
-
-* **Source**: Computed from commit diffs in our Git version-control system, excluding merge commits and auto-generated files.
-* **Aggregation**: Grouped by ISO week (Monday–Sunday).
-* **Purpose**:
-   * Tracks engineering velocity and throughput over time.
-   * Highlights spikes (e.g., major feature work or refactors) and troughs (e.g., stabilization periods, planning, or holidays).
-   * Helps correlate process changes (code freezes, new tooling) with fluctuations in developer output.`,
+		meta.Title,
+		body,
 		result,
 	)
 	if err != nil {
@@ -65,6 +68,13 @@ func CodeChangeMarkdownHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+type OSSMetricQueryBuilder[ func(weeks []string, team *int64) data.AggregatedValuesQuery
+
+
+func OSSMetricHandler[T any]() {
+}
+
+
 func CodeChangeHandler(w http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 

internal/util/markdown_file.go

@@ -0,0 +1,39 @@
+package util
+
+import (
+	"fmt"
+	"io/fs"
+	"strings"
+
+	"gopkg.in/yaml.v2"
+)
+
+func ReadMarkdownFromFS[T any](fsys fs.FS, path string) (meta T, body string, err error) {
+	data, err := fs.ReadFile(fsys, path)
+	if err != nil {
+		return meta, "", fmt.Errorf("failed to read %q: %w", path, err)
+	}
+	fm, b, err := splitFrontMatter(data)
+	if err != nil {
+		return meta, "", err
+	}
+	if err := yaml.Unmarshal(fm, &meta); err != nil {
+		return meta, "", fmt.Errorf("parsing frontmatter into %T: %w", meta, err)
+	}
+	return meta, string(b), nil
+}
+
+func splitFrontMatter(data []byte) (fm []byte, body []byte, err error) {
+	const delim = "---\n"
+	text := string(data)
+	if !strings.HasPrefix(text, delim) {
+		return nil, data, nil
+	}
+	parts := strings.SplitN(text, "\n---\n", 2)
+	if len(parts) != 2 {
+		return nil, nil, fmt.Errorf("invalid frontmatter format")
+	}
+	fm = []byte(strings.TrimPrefix(parts[0], delim))
+	body = []byte(parts[1])
+	return fm, body, nil
+}