[Good first issue] 增加免安装可读的投研报告示例

Aperta
#71 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, typescript
Ambito
documentation

Direzione di ricerca

Start with reportFixture() in packages/shared/src/export/test-helpers.ts and reportToMarkdown() in packages/shared/src/export/markdown.ts, then run the export twice to confirm the output is stable. Commit a short synthetic Markdown report that states it is generated data, and check that each run ID in the evidence section matches a fixture record. Add a direct link from the English and Chinese README files, then verify the links in GitHub's Markdown preview. Before starting, post your intended scope and comment /claim as the issue asks.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue help wanted priority:next

场景

访客现在可以看 README 截图和视频。再提供一份可以直接在 GitHub 阅读的短报告,让访客在安装前就能看懂一次研究如何从数据到结论,再用一个证据条目追溯到对应输入。

当前 reportFixture() 和 reportToMarkdown() 可以离线生成稳定结果。我用同一个 fixture 连续导出两次,正文一致,证据段保留了对应的 capability 和 run ID。

验收标准

  • 提交一份短 Markdown 示例报告,包含结论、风险和证据段。报告开头明确标注合成数据和生成方式。
  • 展示至少一个能从报告中的 run ID 查到对应 fixture 记录的例子,给出无需账号的再生成命令。
  • 从中英文 README 各加一个直接阅读的链接,用 GitHub Markdown 预览核对报告与源数据链接。

源码起点

认领前先说明准备完成的范围,再评论 /claim。参与方式见 #7。

Lingua principale
TypeScript
Stelle
206
Fork
37
Merge medio
7h 8m
PR unite (30g)
8

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ydflow/Trail

Tutte le issue di ydflow/Trail

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.