docs.filecoin.io

{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048,
      "description": "Explain the issue in full, as if writing to a documentation maintainer who never saw this conversation. Describe what is wrong, where on the page it appears (quote the exact sentence or section title when possible), what the user was trying to do, and, when relevant, what the correct or expected information should be. Write a few clear, specific sentences in English. Never include personal or confidential information from the conversation. Up to 2048 characters."
    },
    "pageUrl": {
      "type": "string",
      "description": "The full URL of the page the issue is about (e.g. https://docs.filecoin.io//getting-started), so the finding is linked to the exact page."
    },
    "goal": {
      "type": "string",
      "maxLength": 1024,
      "description": "The broader end goal you were ultimately trying to accomplish (as/on behalf of the user) when you hit this issue. Gives the team the context you were working towards. Optional."
    }
  },
  "required": [
    "content",
    "pageUrl"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}