Skip to content

Improve monorepository getting started documentation#1487

Merged
Krusty93 merged 19 commits intomainfrom
CES-1691-aggiornare-pagina-documentazione-dx-init
Apr 3, 2026
Merged

Improve monorepository getting started documentation#1487
Krusty93 merged 19 commits intomainfrom
CES-1691-aggiornare-pagina-documentazione-dx-init

Conversation

@Krusty93
Copy link
Copy Markdown
Contributor

@Krusty93 Krusty93 commented Mar 25, 2026

Resolves CES-1691, CES-1816

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 25, 2026

🦋 Changeset detected

Latest commit: 96d243e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
docs Patch

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

Comment thread apps/website/docs/dx-cli/index.md Outdated
Comment thread apps/website/docs/monorepository-setup.mdx Outdated
@Krusty93 Krusty93 marked this pull request as ready for review March 25, 2026 10:10
@Krusty93 Krusty93 requested a review from a team as a code owner March 25, 2026 10:10
Copilot AI review requested due to automatic review settings March 25, 2026 10:10
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 init end-to-end workflow (GitHub App prep → init → infra apply → repository registration).
  • Expanded DX CLI docs with a prerequisites section and a detailed init prompt 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.

Comment thread apps/website/docs/dx-cli/index.md
Comment thread apps/website/docs/monorepository-setup.mdx Outdated
Comment thread apps/website/docs/monorepository-setup.md Outdated
Comment thread apps/website/docs/monorepository-setup.md Outdated
Comment thread apps/website/docs/dx-cli/index.md Outdated
Copy link
Copy Markdown
Member

@lucacavallaro lucacavallaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment thread apps/website/docs/dx-cli/index.md Outdated
Comment thread apps/website/docs/dx-cli/index.md Outdated
Comment thread apps/website/docs/dx-cli/index.md
Comment thread apps/website/docs/dx-cli/index.md Outdated
Comment thread apps/website/docs/monorepository-setup.md Outdated
@pagopa pagopa deleted a comment from Copilot AI Mar 26, 2026
@Krusty93 Krusty93 force-pushed the CES-1691-aggiornare-pagina-documentazione-dx-init branch from 951e8aa to 64deaf2 Compare March 27, 2026 10:31
Comment thread apps/website/docs/monorepository-setup.md Outdated
@gunzip
Copy link
Copy Markdown
Contributor

gunzip commented Mar 27, 2026

it looks like formatting checks fail

@Krusty93
Copy link
Copy Markdown
Contributor Author

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)

Done!

@Krusty93 Krusty93 force-pushed the CES-1691-aggiornare-pagina-documentazione-dx-init branch 2 times, most recently from 4265223 to 11d505e Compare March 27, 2026 13:56
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Comment thread apps/website/docs/monorepository-setup.mdx Outdated
Comment thread apps/website/docs/monorepository-setup.mdx Outdated
Comment thread apps/website/docs/monorepository-setup.mdx Outdated
Comment thread apps/website/docs/monorepository-setup.mdx Outdated
Comment thread apps/website/docs/dx-cli/index.md
Comment thread apps/website/docs/monorepository-setup.mdx Outdated
Comment thread apps/website/docs/monorepository-setup.mdx
@Krusty93 Krusty93 force-pushed the CES-1691-aggiornare-pagina-documentazione-dx-init branch from f56333c to 3248662 Compare April 3, 2026 14:21
@Krusty93 Krusty93 force-pushed the CES-1691-aggiornare-pagina-documentazione-dx-init branch from be73fa2 to 875497e Compare April 3, 2026 14:31
Copy link
Copy Markdown
Contributor

@mamu0 mamu0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-mud-0405c6703-1487.westeurope.1.azurestaticapps.net

@Krusty93 Krusty93 merged commit 05f2b5a into main Apr 3, 2026
10 checks passed
@Krusty93 Krusty93 deleted the CES-1691-aggiornare-pagina-documentazione-dx-init branch April 3, 2026 14:34
@dx-pagopa-bot dx-pagopa-bot mentioned this pull request Apr 3, 2026
Krusty93 pushed a commit that referenced this pull request Apr 3, 2026
This PR was opened by the [Nx
Release](https://github.com/pagopa/dx/tree/main/actions/nx-release)
GitHub Action. When you're ready to do a release, you can merge this and
the packages will be published automatically. If you're not ready to do
a release yet, that's fine, whenever you add more Nx version plans to
main, this PR will be updated.

# Releases
## @pagopa/dx-cli@0.19.0

### 🚀 Features
- Update dx doctor to check for Nx
([#1554](#1554))
- Generated workspaces now use Nx instead of Turborepo
([#1551](#1551))
- Remove environment initialization from init command
([#1552](#1552))
### ❤️ Thank You
- Copilot @Copilot
- Luca Cavallaro

## docs@0.15.0

### 🚀 Features
- Add website docs for DX Copilot plugins
([#1540](#1540))
### 🩹 Fixes
- Update docs with new nx-release action page
([#1486](#1486),
[#1510](#1510))
- Improve documentation for monorepositories and dx-cli init command
([#1487](#1487))
- Align documentation for Nx Release instead of Changeset, add new page
for Version Plans ([#1570](#1570))
### ❤️ Thank You
- Andrea Grillo
- Copilot @Copilot
- Danilo Spinelli @gunzip
- Luca Cavallaro
- Mario Mupo @mamu0

## github_environment_bootstrap@1.1.8

### 🩹 Fixes
- Do not use the `has_downloads` attribute since it's been deprecated
([#1568](#1568))
### ❤️ Thank You
- Marco Comi @kin0992

## setup-telemetry-action@0.1.6

### 🩹 Fixes
- Upgrade node version to node24
([#1567](#1567))
### ❤️ Thank You
- Andrea Grillo
- Copilot @Copilot
- Marco Comi

<!-- nx-release-tags:
[{"path":"apps/cli","tag":"@pagopa/dx-cli@0.19.0","version":"0.19.0"},{"path":"apps/website","tag":"docs@0.15.0","version":"0.15.0"},{"path":"infra/modules/github_environment_bootstrap","tag":"github_environment_bootstrap@1.1.8","version":"1.1.8"},{"path":"actions/setup-telemetry","tag":"setup-telemetry-action@0.1.6","version":"0.1.6"}]
-->

Co-authored-by: dx-pagopa-bot <dx-pagopa-bot@users.noreply.github.com>
dx-pagopa-bot added a commit to pagopa-dx/terraform-github-github-environment-bootstrap that referenced this pull request Apr 3, 2026
This PR was opened by the [Nx
Release](https://github.com/pagopa/dx/tree/main/actions/nx-release)
GitHub Action. When you're ready to do a release, you can merge this and
the packages will be published automatically. If you're not ready to do
a release yet, that's fine, whenever you add more Nx version plans to
main, this PR will be updated.

# Releases
## @pagopa/dx-cli@0.19.0

### 🚀 Features
- Update dx doctor to check for Nx
([#1554](pagopa/dx#1554))
- Generated workspaces now use Nx instead of Turborepo
([#1551](pagopa/dx#1551))
- Remove environment initialization from init command
([#1552](pagopa/dx#1552))
### ❤️ Thank You
- Copilot @Copilot
- Luca Cavallaro

## docs@0.15.0

### 🚀 Features
- Add website docs for DX Copilot plugins
([#1540](pagopa/dx#1540))
### 🩹 Fixes
- Update docs with new nx-release action page
([#1486](pagopa/dx#1486),
[#1510](pagopa/dx#1510))
- Improve documentation for monorepositories and dx-cli init command
([#1487](pagopa/dx#1487))
- Align documentation for Nx Release instead of Changeset, add new page
for Version Plans ([#1570](pagopa/dx#1570))
### ❤️ Thank You
- Andrea Grillo
- Copilot @Copilot
- Danilo Spinelli @gunzip
- Luca Cavallaro
- Mario Mupo @mamu0

## github_environment_bootstrap@1.1.8

### 🩹 Fixes
- Do not use the `has_downloads` attribute since it's been deprecated
([#1568](pagopa/dx#1568))
### ❤️ Thank You
- Marco Comi @kin0992

## setup-telemetry-action@0.1.6

### 🩹 Fixes
- Upgrade node version to node24
([#1567](pagopa/dx#1567))
### ❤️ Thank You
- Andrea Grillo
- Copilot @Copilot
- Marco Comi

<!-- nx-release-tags:
[{"path":"apps/cli","tag":"@pagopa/dx-cli@0.19.0","version":"0.19.0"},{"path":"apps/website","tag":"docs@0.15.0","version":"0.15.0"},{"path":"infra/modules/github_environment_bootstrap","tag":"github_environment_bootstrap@1.1.8","version":"1.1.8"},{"path":"actions/setup-telemetry","tag":"setup-telemetry-action@0.1.6","version":"0.1.6"}]
-->

Co-authored-by: dx-pagopa-bot <dx-pagopa-bot@users.noreply.github.com>
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.

6 participants