Documentation: Consider Adding metadata.keywords

[abhillman]

Problem

NixOS Options on search.nixos.org is a fantastic feature. That said, search results can be constrained on account of a given search being missing from a given option description.

Here is a concrete example of a change request where this feature would enhance searchability for options while reducing maintainability burdens #257029.

Proposal

There are two options I can think of that would help with this problem:

We propose that the meta section for a given package contains a keywords section

Counter-argument

This section does not normally exist the GitHub nixpkgs issues template, but I add it for completeness. One of the disadvantages of a keywords section is that it could potentially lead to extraneous search results. That said, I can not readily think of a concrete example (i.e. search query/keyword) that would exhibit this potential problem.

Checklist

• checked latest Nixpkgs manual (source) and latest NixOS manual (source)
• checked open documentation issues for possible duplicates
• checked open documentation pull requests for possible solutions