---
name: 📚 Documentation Bug Report / Unclear Documentation
about: Use this template to report issues, inconsistencies, or inaccuracies in our documentation. Or to report sections of our documentation that are unclear, confusing, or require further explanation.
title: ""
labels: bug, documentation
assignees: ""
---

### **Page Link**

Please provide a link to the page where the issue is located:  
**URL**: '[https://docs.zama.ai/fhevm/\_\_\_](https://docs.zama.ai/fhevm/___)'

### **Description**

Describe in detail what part of the documentation is unclear or provide a clear and detailed description of the bug. Include any inconsistencies, typos, broken links, or missing information.

<details><summary>For example:</summary>
<p>
 <li>Inaccurate technical explanations or missing prerequisites.</li>
 <li>Deprecated code snippets or outdated references.</li>
 <li>Formatting issues or broken links.</li>
 <li>Is there a lack of explanation for certain technical terms or concepts?</li>
 <li>Are there missing examples for a complex function or feature?</li>
 <li>Does the documentation assume prior knowledge that hasn't been introduced?</li>
</p>
</details>

### **Suggested Fix / Expected Behavior / What Would You Like Clarified?**

Please provide your suggestions for improvement or clarification:

- Describe expected content or suggest corrections for bugs/inaccuracies.
- Explain what needs clarification for unclear documentation.

<details><summary>Examples of helpful suggestions:</summary>
<p>
 <li>Corrected code snippet</li>
 <li>Improved explanation.</li>
 <li>Link to a more accurate or up-to-date resource</li>
</p>
</details>

<details><summary>Examples of clarification requests:</summary>
<p>
 <li>“Can you provide an example of this function in use?”</li>
 <li>"What are the expected inputs and outputs for this operation?”</li>
 <li>“Could you add a section explaining how this feature integrates with other components?”</li>
</p>
</details>

### **Screenshots / Logs**

If applicable, provide screenshots, code snippets, or logs that clearly show the issue.

### **Impact Level**

Choose the impact of the bug on the documentation quality and user experience:

<details><summary>[Critical, Moderate, Minor]</summary>
<p>
<li><b>Critical</b>: Major error that could lead to incorrect implementation or misunderstanding.</li>
<li><b>Moderate</b>: Somewhat misleading information, but unlikely to cause implementation issues.</li>
<li><b>Minor</b>: Minor typo or aesthetic issue with no functional impact.</li>
</p>
</details>

---

By including these details, we can ensure a faster and more accurate resolution for your issue. Thank you for helping improve `fhEVM docs`!
