CtrlK
BlogDocsLog inGet started
Tessl Logo

akshay-babbar/doc-sync

Auto-syncs stale docstrings and README when function signatures change. Detects documentation drift after refactors, parameter additions, or return type changes. Dry-run by default — proposes before writing.

87

1.59x
Quality

100%

Does it follow best practices?

Impact

86%

1.59x

Average score across 17 eval scenarios

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

task.mdevals/scenario-17/

Sync Documentation for Renamed Return Type in Analytics Module

A data team updated a TypeScript analytics function to return a richer result type. The function has a JSDoc comment. The README.md contains a reference table that lists exported functions and their descriptions. The team wants a documentation sync report.

The team wants a documentation sync report. Use --apply mode on the latest committed change.

Setup

Extract the following files, then set up the git repository:

=============== FILE: inputs/setup.sh =============== #!/usr/bin/env bash set -euo pipefail git init git config user.email "dev@example.com" git config user.name "Dev" mkdir -p src cat > src/analytics.ts << 'TSEOF' /**

  • Aggregate daily metrics for a given date range.
  • @param startDate - ISO date string for range start.
  • @param endDate - ISO date string for range end.
  • @returns Aggregated count of events. */ export function aggregateMetrics(startDate: string, endDate: string): number { return 0; } TSEOF cat > README.md << 'MDEOF'

Analytics Module

Exported Functions

FunctionDescription
aggregateMetricsAggregates daily metrics over a date range. Returns a count.
MDEOF
git add -A && git commit -m "baseline"
cat > src/analytics.ts << 'TSEOF'
export interface MetricsSummary {
count: number;
average: number;
}

/**

  • Aggregate daily metrics for a given date range.
  • @param startDate - ISO date string for range start.
  • @param endDate - ISO date string for range end.
  • @returns Summary object with count and average. */ export function aggregateMetrics(startDate: string, endDate: string): MetricsSummary { return { count: 0, average: 0 }; } TSEOF git add -A && git commit -m "aggregateMetrics now returns MetricsSummary"

Output Specification

Sync the documentation and write the results to doc-sync-report.md.

evals

README.md

SKILL.md

tessl.json

tile.json

TRUST.md