Skip to content

Docs improvement: Docs version matching CLI version. #1999

@pmatthews05

Description

@pmatthews05

My experience when learning how to use M365 cli is to go directly to your documents to understand how the commands work. So today for example I went to https://pnp.github.io/cli-microsoft365/cmd/login/ to understand different ways you could log in. I didn't realise until I raised an issue, that I was viewing commands that were only available for the latest beta version of M365 CLI.

Benefit of having versioned docs:

  1. The latest release matches the documents.
  2. People who cannot always upgrade to the latest can switch to the version they are using to ensure the commands they want to use matches the version of the M365 CLI that they have installed.

Can you please look into adding a version switch to your docs with MKDocs Material.

@garrytrinder stated in previous comment on issue #1995

It's not quite a simple as upgrading MkDocs, we also have to think about our integration with MarkShell which we use to display the docs in the CLI --help command, certainly not impossible though.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions