docfx
docfx copied to clipboard
QuickStart guide does not specify downloading DocFx 2
Operating System: (Windows or Linux or MacOS)
N/A
DocFX Version Used: Version 3.0.0-beta1.1204+6e13fb0a39
Template used: (default or statictoc or contain custom template)
N/A
Steps to Reproduce:
- Go to DocFx homepage
- Click "Get Started" and get sent to the QuickStartGuide
- On step 2 of the guide, download the topmost release from this github's releases page. At the time of writing this is Version 3.0.0-beta1.1204+6e13fb0a39
- Run
docfx init -q
Expected Behavior: The guide specifying not to download version 3, or at least specifying that it's for DocFx 2. It'd be nice if DocFx 3 also had a specific error when trying to run docfx init, explaining that it's version 3 not 2.
Actual Behavior: The following error:
'init' was not matched. Did you mean 'new'?
'-q' was not matched. Did you mean '-h'?
Required command was not provided.
Unrecognized command or argument 'init'
Unrecognized command or argument '-q'
Additional Notes Duplicate of closed issue #7190
@ITR13 Version 3.0.0-beta1.1204+6e13fb0a39 is DocFX 3, and it is in beta - you are on your own if you want to try it. This is not the DocFX 2 you are referring to.