# 2023-07-17 Documentation team meeting notes #64

**URL:** https://discourse.nixos.org/t/2023-07-17-documentation-team-meeting-notes-64/30653
**Category:** Documentation
**Created:** [July 18, 2023, 6:54pm UTC](https://discourse.nixos.org/t/2023-07-17-documentation-team-meeting-notes-64/30653 "2023-07-18T18:54:51Z")
**Posts on this page:** 3
**Page:** 1

<div class="post-metadata">

### Author: ![proofconstruction](https://discourse.nixos.org/user_avatar/discourse.nixos.org/proofconstruction/32/9615_2.png) [@proofconstruction](https://discourse.nixos.org/u/proofconstruction)
#### Post date: [July 18, 2023, 6:54pm UTC](https://discourse.nixos.org/t/2023-07-17-documentation-team-meeting-notes-64/30653/1 "2023-07-18T18:54:51Z")

</div>

- [Video conference](https://meet.jit.si/nix-documentation)
- [GitHub project board](https://github.com/orgs/NixOS/projects/15)
- [Team details](https://github.com/NixOS/nix.dev/tree/master/maintainers)
- [Past meeting notes](https://discourse.nixos.org/search?q=documentation%20team%20meeting)
- Attendees: @fricklerhandwerk @infinisil @henrik-ch @mightyiam @proofconstruction
- Notes by: @infinisil

## Agenda

- updates

## Notes

- @mightyiam: can we change the Jitsi Meet identifier to one that does not trigger the unsafe warning?
  - Minor issue

- Reviewing [adding nix pills to external sources. by henrik-ch · Pull Request #649 · NixOS/nix.dev · GitHub](https://github.com/NixOS/nix.dev/pull/649)
  - Let’s re-use the blurb from [nixos.org](http://nixos.org)
  - Missing how to contribute to Nix Pills.
    - There’s ideas for a tool to have unified markdown doc infra, but still not planned
    - Moving parts of nix pills into nix.dev?
      - @henrik-ch: Changing in place would be good
      - @proofconstruction: Moving parts sounds good, bit outdated, but linked often
      - @fricklerhandwerk: Need more explanation-type docs, e.g. [this blog post](https://summer.nixos.org/blog/callpackage-a-tool-for-the-lazy/) with some more history could be a good explanation

    - (other ideas posted in a PR comment)

- Reviewing [remove "Software Nix has influenced" by fricklerhandwerk · Pull Request #295 · NixOS/nix.dev · GitHub](https://github.com/NixOS/nix.dev/pull/295)
  - Approval by everybody present

- Reviewing [Are more maintainers needed for this repo? · Issue #66 · NixOS/templates · GitHub](https://github.com/NixOS/templates/issues/66)
  - Hard to answer without answering Flakes documentation more generally
  - @fricklerhandwerk: Not a fan of it being an official repo
  - @mightyiam: Not really part of docs, we shouldn’t be responsible for this
  - @infinisil: Part of Flakes really, Nix team should be responsible
    - @fricklerhandwerk: Nix team is recently trying to split up maintenance of frontend-style code, rather no

- Regarding [teaching Nix 3 CLI and Flakes · Issue #281 · NixOS/nix.dev · GitHub](https://github.com/NixOS/nix.dev/issues/281#issuecomment-1637910480)
  - Cannot afford to spend time on this right now, bigger problems
  - @infinisil: If people want flakes to be officially documented, work on Flakes stabilisation.

- Reviewing [https://github.com/NixOS/nixpkgs/pull/237439/files#diff-d9e77bfcb681fae6baf681117c55d2b9119546a2a8727a876a8b497fa69dcd90](https://github.com/NixOS/nixpkgs/pull/237439/files#diff-d9e77bfcb681fae6baf681117c55d2b9119546a2a8727a876a8b497fa69dcd90)
  - Let’s have clickable links when possible
  - Think about how to add more details to this overview
    - Maybe `<details></details>` works → No, HTML doesn’t work
    - Extra lines after overview line
    - Readme’s in the directories or comments at the top of files should be good, point out that Readme’s exist

  - Explain what entry-points means, explain what aggregations mean, make it easy to understand for anybody

---

<div class="post-metadata">

### Author: ![Infinisil](https://discourse.nixos.org/user_avatar/discourse.nixos.org/infinisil/32/26523_2.png) [@Infinisil](https://discourse.nixos.org/u/Infinisil)
#### Post date: [August 2, 2023, 6:28pm UTC](https://discourse.nixos.org/t/2023-07-17-documentation-team-meeting-notes-64/30653/2 "2023-08-02T18:28:09Z")

</div>

Do you happen to have [this section](https://github.com/NixOS/nixpkgs/pull/237439/files#diff-d9e77bfcb681fae6baf681117c55d2b9119546a2a8727a876a8b497fa69dcd90) we copied into the meeting notes and hacked on? I’m now trying to implement the changes we worked on together but can’t find them here 😅

---

<div class="post-metadata">

### Author: ![proofconstruction](https://discourse.nixos.org/user_avatar/discourse.nixos.org/proofconstruction/32/9615_2.png) [@proofconstruction](https://discourse.nixos.org/u/proofconstruction)
#### Post date: [August 2, 2023, 8:13pm UTC](https://discourse.nixos.org/t/2023-07-17-documentation-team-meeting-notes-64/30653/3 "2023-08-02T20:13:49Z")

</div>

For posterity:

```auto
- `doc`: Sources and infrastructure for this manual, see also [](#chap-contributing)
- `lib`: Library functions and documentation sources for [](#part-lib)
- `nixos`: NixOS, see the [Development section in the NixOS manual](https://nixos.org/nixos/manual/#ch-development)
- `pkgs`: Entry points for evaluation, packages, builders
  - `top-level`: Entry points, package set aggregations
    - `impure.nix`, `default.nix`, `config.nix`: Definitions for the evaluation entry point of `import <nixpkgs>`
    - `stage.nix`, `all-packages.nix`, `named-hierarchy-files.nix`, `splice.nix`: Definitions for the top-level attribute set made available through `import <nixpkgs> {…}`
    - `*-packages.nix`, `linux-kernels.nix`, `unixtools.nix`: Aggregations of nested package sets defined in `pkgs/development`
    - `aliases.nix`, `python-aliases.nix`: Aliases for package definitions that have been renamed or removed 
    - `release*.nix`, `make-tarball.nix`, `packages-config.nix`, `metrics.nix`, `nixpkgs-basic-release-checks.nix`: Entry-points and utilities used by Hydra for continuous integration
  - `development`
    - `*-modules`, `*-packages`, `*-pkgs`: Package definitions for nested package sets
    - All other directories loosely categorise top-level package definitions
  - `build-support`: [Builders](#part-builders)
    - `fetch*`: [Fetchers](#chap-pkgs-fetchers)
  - `stdenv`: [Standard environment](#part-stdenv)
  - `pkgs-lib`: Definitions for utilities that need packages but are not needed for packages
  - `test`: Tests not directly associated with any specific packages
  - `by-name`: Named hierarchy of top-level package definitions
  - All other directories loosely categorise top-level packages definitions

Each directory linked here has a `README.md` file with details about its purpose and contents. Similarly, files have comments at the top.

```
