[DOCS] Inconsistent monorepo const name

[JoshuaToth]

Describe the issue

When vending a new project for typescript via:

pdk new --package-manager=pnpm monorepo-ts

You are vended the project as:

import { javascript } from "projen";
import { monorepo } from "@aws/pdk";
const project = new monorepo.MonorepoTsProject({
  devDeps: ["@aws/pdk"],
  name: "nib",
  packageManager: javascript.NodePackageManager.PNPM,
  projenrcTs: true,
});
project.synth();

With const project as the monorepo name. And monorepo being an import from the @aws/pdk project.

Discrepancy

In the documentation for many pages, the const monorepo is used as the name (or expected to be used)

i.e

const website = new CloudscapeReactTsWebsiteProject({
    parent: monorepo,
    outdir: "packages/website",
    name: "website",
    typeSafeApi: api,
});

Which may lead to some confusion. Particularly since monorepo is already imported by the generation.

This is also apparent on the Your first AWS PDK Project page where there is an example of the code generated in an IDE and then the code example further down swaps from project to monorepo :

Links

https://aws.github.io/aws-pdk/getting_started/your_first_aws_pdk_project.html

https://aws.github.io/aws-pdk/developer_guides/cloudscape-react-ts-website/index.html

https://aws.github.io/aws-pdk/developer_guides/infrastructure/index.html

Pretty much wherever there is code snippets it's different to the generated code.

[agdimech]

Hi Josh,

Thanks for your feedback.

Unfortunately projen's codegen is a little primitive and doesn't allow renaming variables so it defaults to project. We rename the variable from project -> monorepo for better readability as project is a little vague. This is actually noted as an inline comment within the Type-Safe API snippet you posted above. Do you have a suggestion on how this could be made clearer?

[JoshuaToth]

Ah, shame about the limitation, no particular suggestions if that can't be changed.

[agdimech]

Happy to close this issue then @JoshuaToth ?