Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclear whether the plugin CLI is required or optional #910

Open
imnotashrimp opened this issue Aug 9, 2024 · 1 comment
Open

Unclear whether the plugin CLI is required or optional #910

imnotashrimp opened this issue Aug 9, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@imnotashrimp
Copy link

Documentation link

https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/demo/docs/intro.mdx?plain=1#L238

Describe the problem

Here, the statement is "the CLI can be used to generate and clean API docs." I can't tell from this wording whether the CLI is optional or required.

I also found an issue comment here ("You didn't specify that you actually ran the CLI command to generate the docs from the api plugin. In case you didn't, you would run..."), which makes me think the CLI is required before running docusaurus build.

So the problem is: I think the CLI is required, but I can't tell from the documentation whether that's the case.

Suggested fix

  1. The statement I quoted above should be clarified.
  2. If the plugin CLI is a prerequisite to building the Docusaurus site, the required flow (generate API docs with the CLI, then docusaurus build) needs to be explicitly stated and made much more visible.

I'm happy to open a PR once I know what the required steps are.

@imnotashrimp imnotashrimp added the documentation Improvements or additions to documentation label Aug 9, 2024
@sserrata
Copy link
Member

sserrata commented Aug 9, 2024

Hi @imnotashrimp, the CLI is indeed required for generating/cleaning API docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants