Better documentation for onboarding existing projects

[clarkmcc]

Describe the problem

There's very little documentation in the README. Basically the only usage documentation is the instructions at the bottom saying to clone the repo and start with the demo. I'm trying to use this plugin in an existing documentation project and after cloning the demo and looking around, there's just so much configured in there and I don't know what's what.

Suggested fix

Either:

• Provide a step-by-step for integrating into an existing docusaurus project.
• Provide one or more minimal examples so that we can figure out how to boot up this project within the context of our documentation without all the extra fluff in the larger demo example.

Project seems great if we can figure out how to run it!

[welcome-to-palo-alto-networks[bot]]

:tada: Thanks for opening your first issue here! Welcome to the community!

[clarkmcc]

Just wanted to point out that I got re-docusaurus up and running in our project in <2 minutes. https://redocusaurus.vercel.app/docs/getting-started/Installation. I like the look and feel of this project better so I'd still love to find a way to get this to work.

[sserrata]

Hi @clarkmcc, thanks for the suggestion. The current instructions at the bottom of the README are intended for plugin contributors, not necessarily users.

Plugin options and basic usage are in fact documented, but I can see how that might not be enough for some users to get started. I think what you're asking for is a "Quickstart" or "Getting Started" guide/tutorial for existing Docusaurus projects.

[clarkmcc]

@sserrata yes, if possible, that would be great.