Skip to content

Reorganizes the getting started docs. Closes #6818 - #7474

Open
JakPit23 wants to merge 2 commits into
pnp:mainfrom
JakPit23:docs/getting-started-reorg
Open

Reorganizes the getting started docs. Closes #6818#7474
JakPit23 wants to merge 2 commits into
pnp:mainfrom
JakPit23:docs/getting-started-reorg

Conversation

@JakPit23

@JakPit23 JakPit23 commented Aug 5, 2026

Copy link
Copy Markdown

Reorganizes the getting started docs. Closes #6818

@milanholemans
milanholemans requested a lite review from Copilot August 5, 2026 20:31
@milanholemans

Copy link
Copy Markdown
Contributor

Thanks @JakPit23, we'll try to review it soon.

@milanholemans

Copy link
Copy Markdown
Contributor

Seems like there are some broken links, could you have a look @JakPit23?

@milanholemans
milanholemans marked this pull request as draft August 5, 2026 20:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR reorganizes the documentation to make initial install → setup → login guidance more discoverable and step-by-step, aligning with issue #6818’s requested “Getting Started” flow.

Changes:

  • Adds a new Getting Started doc group with a new Overview page and a new “Setup the CLI” guide, and orders pages to match the recommended onboarding path.
  • Updates existing pages and cross-links to point to the new Getting Started structure (including login command docs and release notes).
  • Refines the “Use your own Microsoft Entra identity” page intro to emphasize the app registration requirement and the recommended m365 setup path.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/docs/user-guide/using-own-identity.mdx Updates intro copy to clarify app registration prerequisite and the m365 setup vs manual path.
docs/docs/user-guide/getting-started/setup-cli.mdx Adds a new “Setup the CLI” page that points users to m365 setup and manual registration fallback.
docs/docs/user-guide/getting-started/overview.mdx Adds a new onboarding overview with “Install → Setup → Login” quick start and links to deeper guides.
docs/docs/user-guide/getting-started/installing-cli.mdx Adjusts sidebar position and fixes relative links after moving into Getting Started.
docs/docs/user-guide/getting-started/connecting-microsoft-365.mdx Adjusts sidebar position and updates guidance/links to reference the new setup guide and correct relative paths.
docs/docs/user-guide/getting-started/category.yml Introduces the “Getting Started” sidebar category configuration.
docs/docs/index.mdx Updates the docs landing page to direct users to the new Getting Started overview and related setup guidance.
docs/docs/cmd/login.mdx Updates the “limitations” link to the new location of the login guide.
docs/docs/about/release-notes.mdx Updates the historical release note link to the moved “Install the CLI” page.
Suppressed comments (2)

docs/docs/user-guide/getting-started/installing-cli.mdx:101

  • This sentence is grammatically off ("New version ... often contains...") and is missing a comma after "For more information".

This issue also appears on line 109 of the same file.
docs/docs/user-guide/getting-started/installing-cli.mdx:109

  • The last sentence is missing a comma after "For more information" and a terminating period after the link.


If you can't use the setup wizard, continue with [Use your own Microsoft Entra identity](../using-own-identity.mdx) to create the app registration manually.

### 3. Login
@JakPit23

JakPit23 commented Aug 6, 2026

Copy link
Copy Markdown
Author

@milanholemans I can't see any broken links on my local repo. I see that it comes from /cli-microsoft365/beta/user-guide/automation/azure-function-powershell but I can't see this page at all.

@milanholemans

Copy link
Copy Markdown
Contributor

@milanholemans I can't see any broken links on my local repo. I see that it comes from /cli-microsoft365/beta/user-guide/automation/azure-function-powershell but I can't see this page at all.

You can ignore the /beta/ part, this is just dynamically built in our pipeline. But the issue is still in the user-guide/automation/azure-function-powershell page. There is a link to a page that was moved to a different folder. If you run npm run build locally, you'll also get the error with the correct path.

@JakPit23
JakPit23 force-pushed the docs/getting-started-reorg branch from 5871680 to 2070532 Compare August 6, 2026 17:20
@JakPit23
JakPit23 marked this pull request as ready for review August 6, 2026 17:20
@JakPit23

JakPit23 commented Aug 6, 2026

Copy link
Copy Markdown
Author

Thank you, it should be fixed now. And sorry for this mistake

@milanholemans

Copy link
Copy Markdown
Contributor

Thank you, it should be fixed now. And sorry for this mistake

No problem. Everyone has to get used to a new project 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs to increase visibility of setup guide

3 participants