Skip to content

docs: regenerate package README.AUTOGEN.md files (2026-07-01)#2578

Open
typeagent-bot[bot] wants to merge 1 commit into
mainfrom
automated/docs-readmes-20260701-254
Open

docs: regenerate package README.AUTOGEN.md files (2026-07-01)#2578
typeagent-bot[bot] wants to merge 1 commit into
mainfrom
automated/docs-readmes-20260701-254

Conversation

@typeagent-bot

@typeagent-bot typeagent-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Automated package README.AUTOGEN.md regeneration

Opened by TypeAgent-Bot. The AI-authored documentation body is
generated via GitHub Models (no Azure OpenAI, no federated
credential, no stored secret); the deterministic Reference appendix
is computed from package.json + src/ + the workspace graph.

Summary

  • Files updated: 11 README.AUTOGEN.md file(s)
  • Model: openai/gpt-4o (GitHub Models)
  • Per-run cap: none (every drifted package regenerated)
  • Trigger: schedule

How this works

  1. Diffs ts/packages/** source against the last
    README.AUTOGEN.md commit, so only drifted packages are
    regenerated and every run reproduces the full current drift.
  2. README.md is never modified — read only as authoritative
    source material the model mirrors and extends.
  3. Validates every generated link resolves on disk; broken links
    are stripped to plain text before write.
  4. A PR is opened only when a README.AUTOGEN.md actually changed.

Review checklist

  • Spot-check a Reference section against the package.
  • Spot-check the AI-authored prose (no hallucinated APIs).
  • Confirm no hand-written README.md was modified.

A CI gate already enforced that only README.AUTOGEN.md files
are in this diff — no source, config, or other files were touched.

Automated by the docs-generate workflow. AI body authored via
GitHub Models; deterministic Reference computed from source.

11 file(s) updated.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@typeagent-bot typeagent-bot Bot added the documentation Improvements or additions to documentation label Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants