{"componentChunkName":"component---src-templates-doc-tsx","path":"/contributing/minimalist-documentation/","result":{"data":{"file":{"id":"c406798a-2786-5341-b877-70ad50b4435e","relativePath":"contributing/minimalist-documentation.mdx","sourceInstanceName":"docs","childMarkdownRemark":null,"childMdx":{"body":"function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"Our Approach\",\n  \"noindex\": true,\n  \"sidebar_order\": 2\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"p\", null, \"Sentry uses a minimalist approach to documentation. Our docs have one goal: help customers gain mastery \", mdx(\"em\", {\n    parentName: \"p\"\n  }, \"quickly\"), \". Minimalism in documentation puts the reader at the center of the content. Our audience is reading the documentation to solve a problem or finalize a setup or to understand. Thus, think \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"very critically\"), \" about the content that is provided, especially on a primary page.\"), mdx(\"h2\", {\n    \"id\": \"use-this-test\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#use-this-test\",\n    \"aria-label\": \"use this test permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Use This Test\"), mdx(\"p\", null, \"Ask these questions as you're developing content:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"p\", {\n    parentName: \"li\"\n  }, \"Is this information critical to helping a developer get up and running? If not, consider moving it to a subpage with a link to it from the primary page (or, as suggested by one of our engineering managers, \\\"cool, I can bookmark this for later\\\").\")), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"p\", {\n    parentName: \"li\"\n  }, \"Is this obvious from the UI? Our UI is largely self-documenting, so we don't need to explain what's already evident.\"))), mdx(\"h2\", {\n    \"id\": \"what-goes-where\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#what-goes-where\",\n    \"aria-label\": \"what goes where permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"What Goes Where?\"), mdx(\"p\", null, \"Our content has some pretty clear divisions:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Platform content - instrument and configure your SDK\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Product content - look at all the data ingested into Sentry\")), mdx(\"p\", null, \"And within those primary categories:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Reference: What you need to know\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Action: What you can do (modify, filter, and so forth)\")), mdx(\"p\", null, \"If you're uncertain, \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"https://github.com/getsentry/sentry-docs/issues\"\n  }), \"ask\"), \".\"), mdx(\"h2\", {\n    \"id\": \"writing-for-sentry\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#writing-for-sentry\",\n    \"aria-label\": \"writing for sentry permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Writing for Sentry\"), mdx(\"p\", null, \"Keep these concepts in mind when contributing to docs:\"), mdx(\"ol\", null, mdx(\"li\", {\n    parentName: \"ol\"\n  }, \"Technical accuracy is our primary consideration. Our content helps every developer diagnose, fix, and optimize their code.\"), mdx(\"li\", {\n    parentName: \"ol\"\n  }, \"Use inclusive language, which we discuss more fully \", mdx(\"a\", _extends({\n    parentName: \"li\"\n  }, {\n    \"href\": \"https://develop.sentry.dev/inclusion/\"\n  }), \"here\"), \".\"), mdx(\"li\", {\n    parentName: \"ol\"\n  }, \"Feedback is a gift - share your PR so we can improve our content.\")));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#use-this-test","title":"Use This Test"},{"url":"#what-goes-where","title":"What Goes Where?"},{"url":"#writing-for-sentry","title":"Writing for Sentry"}]},"internal":{"type":"Mdx"}}}},"pageContext":{"excerpt":"Sentry uses a minimalist approach to documentation. Our docs have one goal: help customers gain mastery  quickly . Minimalism in documentation puts the reader at the center of the content. Our audience is reading the documentation to solve a problem or finalize a setup or to understand. Thus, think  very critically  about the content that is provided, especially on a primary page. Use This Test Ask these questions as you're developing content: Is this information critical to helping a developer get up and running? If not, consider moving it to a subpage with a link to it from the primary page (or, as suggested by one of our engineering managers, \"cool, I can bookmark this for later\"). Is this obvious from the UI? Our UI is largely self-documenting, so we don't need to explain what's already evident. What Goes Where? Our content has some pretty clear divisions: Platform content - instrument and configure your SDK Product content - look at all the data ingested into Sentry And within those primary categories: Reference: What you need to know Action: What you can do (modify, filter, and so forth) If you're uncertain,  ask . Writing for Sentry Keep these concepts in mind when contributing to docs: Technical accuracy is our primary consideration. Our content helps every developer diagnose, fix, and optimize their code. Use inclusive language, which we discuss more fully  here . Feedback is a gift - share your PR so we can improve our content.","title":"Our Approach","description":null,"draft":null,"noindex":true,"notoc":null,"sidebar_order":2,"redirect_from":null,"keywords":null,"id":"c406798a-2786-5341-b877-70ad50b4435e","legacy":false}},"staticQueryHashes":["1218203755","1222113826","1222113826","1766336459","2158593473","2764967025","3345802723","3818502851","3990806462","4015007367","4192517163","4264099332","518019976"]}