nativelink icon indicating copy to clipboard operation
nativelink copied to clipboard

Autogenerate docs from existing READMEs

Open aaronmondal opened this issue 1 year ago • 2 comments

Syncing documentation manually is a tedious, error prone task.

Since we have Docusaurus with per-commit deployments it should be fairly straightforward to auto-sync all information from the READMEs.

Related: #593

aaronmondal avatar Jan 05 '24 22:01 aaronmondal

Should we have a subset of READMEs that get synced with the docs? Deployment examples are 1:1 but quickstart is intentionally not 1:1 and takes advantage of mdx features.

blakehatch avatar Jan 05 '24 22:01 blakehatch

Should we have a subset of READMEs that get synced with the docs? Deployment examples are 1:1 but quickstart is intentionally not 1:1 and takes advantage of mdx features.

SGTM. I think the most important thing at the moment is to have any sort of syncing at all. We can always exempt certain files if it makes more sense like that.

aaronmondal avatar Jan 05 '24 22:01 aaronmondal

Fixed by

  • #1056

aaronmondal avatar Jun 29 '24 00:06 aaronmondal