nix/.github/ISSUE_TEMPLATE/missing_documentation.md

---
name: Missing or incorrect documentation
about: Help us improve the reference manual
title: ''
labels: documentation
assignees: ''

---

## Problem

<!-- describe your problem -->

## Proposal

<!-- propose a solution -->

## Checklist

<!-- make sure this issue is not redundant or obsolete -->

- [ ] checked [latest Nix manual] \([source])
- [ ] checked [open documentation issues and pull requests] for possible duplicates

[latest Nix manual]: https://nixos.org/manual/nix/unstable/
[source]: https://github.com/NixOS/nix/tree/master/doc/manual/source
[open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation

## Priorities

Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 16:16:17 +00:00			`---`
			`name: Missing or incorrect documentation`
issue template: fill 'about' field according to [GitHub documentation] some fields are required. `about` is not listed, but it probably is required. [GitHub documentation]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms 2022-09-19 08:02:07 +00:00			`about: Help us improve the reference manual`
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 16:16:17 +00:00			`title: ''`
issue template: fill 'about' field according to [GitHub documentation] some fields are required. `about` is not listed, but it probably is required. [GitHub documentation]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms 2022-09-19 08:02:07 +00:00			`labels: documentation`
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 16:16:17 +00:00			`assignees: ''`

			`---`

			`## Problem`

			`<!-- describe your problem -->`

docs issue template: move checklist down it's annoying to write issues with the checklist in the way, and the proposal is more important. 2023-06-15 00:31:47 +00:00			`## Proposal`

			`<!-- propose a solution -->`

add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 16:16:17 +00:00			`## Checklist`

			`<!-- make sure this issue is not redundant or obsolete -->`

fix markdown rendering quirk markdown would interpret parentheses as belonging to the first link without escaping. 2022-09-16 07:41:27 +00:00			`- [ ] checked [latest Nix manual] \([source])`
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 16:16:17 +00:00			`- [ ] checked [open documentation issues and pull requests] for possible duplicates`

			`[latest Nix manual]: https://nixos.org/manual/nix/unstable/`
Rename `doc/manual{src -> source}` This is needed to avoid this https://github.com/mesonbuild/meson/issues/13774 when we go back to making our subproject directory `src`. 2024-10-10 16:04:33 +00:00			`[source]: https://github.com/NixOS/nix/tree/master/doc/manual/source`
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 16:16:17 +00:00			`[open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation`

encourage adding 👍 to express interest decided on the @NixOS/documentation-team, see NixOS/nix.dev#359 for more information 2022-12-01 18:04:04 +00:00			`## Priorities`

			`Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).`