3 ms·
Hi I'm actually working on a guide for this exact topic. My basic thoughts are that there's currently no magic bullet solution and it depends primarily on your
by ndimares 4y ago
Hi I'm actually working on a guide for this exact topic. My basic thoughts are that there's currently no magic bullet solution and it depends primarily on your technical ability and resourcing:
-0 technical skills: notion or atlassian
-pseudotechnical (github & markdown skill): gitbook, or readme
-technical with resourcing constraints: docusaurus, or hugo or mkDocs.
-technical w/o constraints: custom react site: Markdoc + Next.js or Gatsby
The company I'm at is currently technical w/ constraints. We use docusaurus and we use a plugin for autogenerating the openapi documentation: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
It works. The results are not spectacular, merely passable. We think in the near future we will build our own plugin for the community. If you ever want to char docs, get in touch!