Researcher Documentation

Welcome to the researcherdocs developer hub. You'll find comprehensive guides and documentation to help you start working with researcherdocs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Embedded images for Submissions and Comments

Embedding Images directly into the markdown fields of a submission or comments enables Researchers to provide more detailed reports that are easier to review and understand, right from the moment of submission.

Supported Files

While assets up to 100MB can be uploaded, only those at or below 2MB can be embedded into the report.

File-types supported include:

  • GIF
  • JPEG
  • PNG

Adding an embedded image:

To add an embedded image to your submission or comment, follow the Reporting a Bug workflow, until you reach step 8: “We strongly recommend uploading illustrative evidence that…”.

  1. Click add attachment and select your file, then click “open” to begin the upload process:
  1. Once the file has finished loading onto the platform, click the clipboard icon next to the image file you want to embed into your report - this will automatically copy the markdown you need.
  1. Paste the entire copied markdown code into the appropriate spot within your Submission report. Repeat as necessary for additional images.
  2. Preview how the image looks in your submission, or proceed directly to step 5.
  3. Now, return to to the Reporting a Bug workflow, or continue with your comment as appropriate!

Embedded images for Submissions and Comments

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.