To update the live documentation:
- Go to Fern -> Docs -> Pages and add your page there.
- If you are changing the title or adding a new doc update docs.yml.
- Commit changes to the main branch.
- Monitor the actions tab for any errors. Successful updates without errors will automatically push the docs to production at docs.predictionguard.com.
To use images in the documentation, follow these steps (do not use images from the asset folder):
Warning: Any file uploaded to the "publicpgdocimages" bucket is publicly accessible to the Internet. Please be mindful of the data you upload.
-
Upload images to the Amazon S3 bucket: publicpgdocimages.
-
Incorporate the image into your documentation with the following line of code:
-
Commit your changes and verify that the image displays correctly in the documentation.
For adding code blocks and multiple code blocks to your documentation, refer to the Fern documentation on code blocks.
Please edit the OpenAPI file located here. Must be a valid OPENAPI Spec.