---
icon: lucide/file-pen-line
tags:
  - Community
---

<!-- SPDX-FileCopyrightText: 2026 PythonWoods <dev@pythonwoods.dev> -->
<!-- SPDX-License-Identifier: Apache-2.0 -->

# Documentation issues

Our documentation includes extensive information on features, configurations,
and much more. If you have found an inconsistency or see room for improvement,
please follow this guide to submit an issue on our [issue tracker].

  [issue tracker]: https://github.com/PythonWoods/zenzic/issues

## Issue template

Reporting a documentation issue is usually less involved than reporting a bug,
as we don't need a reproduction. Our issue template consists of the following
parts:

- [Title]
- [Description]
- [Related links]
- [Proposed change] <small>optional</small>
- [Checklist]

  [Title]: #title
  [Description]: #description
  [Related links]: #related-links
  [Proposed change]: #proposed-change
  [Checklist]: #checklist

### Title

A good title should be a short, one-sentence description of the issue,
containing all relevant information and keywords to simplify search in our
issue tracker.

### Description

Provide a clear and concise summary of the inconsistency or issue you
encountered. Explain why you think the documentation should be adjusted and
describe the severity of the issue:

- __Keep it short__ – one or two sentences is ideal.

- __One issue at a time__ – create separate issues for unrelated
    inconsistencies.

> __Why we need this__: describing the problem clearly is a prerequisite for
> improving our documentation.

### Related links

Share the link to the specific documentation section that needs adjustment,
and any other related sections. Use anchor links (permanent links) where
possible.

> __Why we need this__: links help us understand which sections need to be
> adjusted, extended, or overhauled.

### Proposed change <small>optional</small> { #proposed-change }

You can help us by proposing an improvement — rough ideas or concrete proposals
are both welcome. This field is optional but invaluable.

> __Why we need this__: improvement proposals benefit other users who encounter
> the same issue before we maintainers can update the documentation.

### Checklist

Thanks for following the guide and providing valuable feedback for our
documentation. The checklist ensures that you have read this guide and provided
us with every piece of information we need to improve it.

__We'll take it from here.__
