Files
ophyd_devices/.github/ISSUE_TEMPLATE/documentation_update.md

1.0 KiB

name, about, title, type, labels, assignees
name about title type labels assignees
Documentation update request Suggest an update to the docs [DOCS]: documentation documentation

Documentation Section

[Link the affected page in bec_docs or identify the README, device docstring, or example configuration in ophyd_devices.]

Current Information

[Provide the current information in the documentation that needs to be updated]

Proposed Update

[Describe the proposed update or correction. Be specific about the changes that need to be made]

Reason for Update

[Explain the reason for the documentation update. Include any recent changes, new features, or corrections that necessitate the update]

Additional Context

[Include any additional context or information that can help the documentation team understand the update better]

Attachments

[Attach any files, screenshots, or references that can assist in making the documentation update]

Priority

[Assign a priority level to the documentation update based on its urgency. Use a scale such as Low, Medium, High]