Improve monorepository getting started documentation#1487
Improve monorepository getting started documentation#1487
Conversation
🦋 Changeset detectedLatest commit: 96d243e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Pull request overview
Updates the “getting started” documentation to center the monorepo bootstrap flow around npx @pagopa/dx-cli init, including prerequisites, GitHub App preparation, and the post-generation infrastructure steps.
Changes:
- Rewrote monorepo setup guide to follow the
dx initend-to-end workflow (GitHub App prep → init → infra apply → repository registration). - Expanded DX CLI docs with a prerequisites section and a detailed
initprompt reference. - Removed the standalone GitHub PAT setup page and added a changeset for the docs package.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| apps/website/docs/monorepository-setup.md | Reframes the monorepo setup as a dx init-driven process and adds post-init operational steps. |
| apps/website/docs/dx-cli/index.md | Adds explicit requirements and a prompt-by-prompt reference for dx init. |
| apps/website/docs/dx-cli/github-pat.md | Removes the PAT setup doc page. |
| .changeset/kind-pillows-trade.md | Publishes the documentation updates as a patch release for the docs package. |
lucacavallaro
left a comment
There was a problem hiding this comment.
I would split the steps in two different sections, based on target audience
- Developers (dx-cli init for an existing product)
- Engineering Leader (github app, initialization, apply of the core module)
951e8aa to
64deaf2
Compare
|
it looks like formatting checks fail |
Done! |
4265223 to
11d505e
Compare
f68b9e1 to
bba9a64
Compare
bba9a64 to
96d243e
Compare
96d243e to
70cf2f3
Compare
70cf2f3 to
849c5fc
Compare
| Confirm the migration when prompted. | ||
|
|
||
| ### Step 2 — Apply `infra/core` (if present) | ||
|
|
There was a problem hiding this comment.
suggestion: I'd add a brief description about what this apply does
| </Tabs> | ||
|
|
||
| ### Step 3 — Verify and apply `infra/bootstrapper` | ||
|
|
There was a problem hiding this comment.
suggestion: I'd add a brief description about what this apply does
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
849c5fc to
4cb70c5
Compare
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-mud-0405c6703-1487.westeurope.1.azurestaticapps.net |
Resolves CES-1691, CES-1816