fix: improve API reference URLs (#720)

Improve the API reference URLs by using markdown files generated by jsii-docgen@5. This PR updates the transliterator to generate both `docs-<lang>.md` and `docs-<lang>.json` files (including two `.corruptedassembly` or `.corruptedassembly` markers for each language where appropriate). Canary metrics continue to be generated based on `.md` files. In addition, generate `docs-xxx.json` files in the backend so that we can move towards using the JSON format for rendering API references on the frontend in the future. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
cdklabs · Jan 20, 2022 · 9dc9837 · 9dc9837
1 parent 374fbbc
commit 9dc9837
Show file tree

Hide file tree

Showing 12 changed files with 5,119 additions and 3,248 deletions.
diff --git a/.projen/tasks.json b/.projen/tasks.json
diff --git a/.projenrc.js b/.projenrc.js
@@ -639,7 +639,7 @@ function newEcsTask(entrypoint) {
     description: `Continuously update an AWS Fargate bundle from ${entry}`,
     exec: [...bundleCmd, '--watch'].join(' '),
   });
-  bundle.env(BUNDLE_DIR_ENV, outdir);
+  bundleWatch.env(BUNDLE_DIR_ENV, outdir);
 
   project.compileTask.spawn(bundle);
   bundleTask.spawn(bundle);

diff --git a/API.md b/API.md
diff --git a/package.json b/package.json
diff --git a/src/__tests__/__snapshots__/construct-hub.test.ts.snap b/src/__tests__/__snapshots__/construct-hub.test.ts.snap