Skip to content

Reorganize documentation and setup repo for Eng.ms compatibility#2568

Merged
GeorgeNgMsft merged 5 commits into
mainfrom
dev/georgeng/docfx_setup
Jun 27, 2026
Merged

Reorganize documentation and setup repo for Eng.ms compatibility#2568
GeorgeNgMsft merged 5 commits into
mainfrom
dev/georgeng/docfx_setup

Conversation

@GeorgeNgMsft

@GeorgeNgMsft GeorgeNgMsft commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

This PR reorganizes our documentation folder to be compatible with Eng.MS. It also establishes a new wiki structure combining a mixture of authored documentation (overview, architecture, etc) and auto-generated docs from the packages/agents (README.Autogen.md, etc).

Example wiki view from local DocFX server
image

  • Conceptual content (overviews, the architecture map, this contributor guide, templates) is hand-authored here under ts/docs/.
  • Architecture deep dives are native files under ts/docs/architecture/**, grouped into sub-directories — the former Design tree now lives in architecture/workflows/. They are edited in place; the DocFX build reads them directly, with no second copy.
  • Package and agent reference is sourced from each package's own README.md and its README.AUTOGEN.md companion (produced by the doc-autogen pipeline) and staged in at build time. A generator keeps the navigation in step with the filesystem so a newly added package or agent shows up automatically.

@GeorgeNgMsft GeorgeNgMsft marked this pull request as ready for review June 27, 2026 03:38
@GeorgeNgMsft GeorgeNgMsft enabled auto-merge June 27, 2026 03:38
@GeorgeNgMsft GeorgeNgMsft disabled auto-merge June 27, 2026 04:06
@GeorgeNgMsft GeorgeNgMsft enabled auto-merge June 27, 2026 04:51
@GeorgeNgMsft GeorgeNgMsft added this pull request to the merge queue Jun 27, 2026
Merged via the queue into main with commit 3a154e9 Jun 27, 2026
20 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant