Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Insufficient links between guide and reference level docs makes splitting challenging #840

Open
lf- opened this issue Dec 15, 2023 · 1 comment
Labels
site Improvements to the site infrastructure or content presentation

Comments

@lf-
Copy link
Member

lf- commented Dec 15, 2023

Observations

Currently there are efforts to split docs into guide vs reference level materials and this is likely great but the reference level docs no longer are next to the relevant guides. We need more deep links between nixpkgs and nix docs and nix.dev guide level materials.

related discussion https://logs.nixos.dev/room/!avYyleMexqjFHoqrME:nixos.org/?anchor=$1a-p0jIFGfppHqFadSnQIpoX40mUALH9qt7griX9qWk&offset=-10

Problem

Hard to get between high level overview (do we even have these materials? like a map between Nix concepts and how they're used in nixpkgs if at all), reference, and guides, especially starting at reference. It's true that Nix shouldn't assume nixpkgs (bull is out of the pen on that one in many cases code wise) but we should link to how nixpkgs uses each high level concept.

Approaches

Add more links and maybe write in the style guide where links are appropriate and how to integrate them.

Willing to help?

yeah

Priorities

Add 👍 to issues you find important.

@lf- lf- added the site Improvements to the site infrastructure or content presentation label Dec 15, 2023
@fricklerhandwerk
Copy link
Collaborator

we should link to how nixpkgs uses each high level concept

The Nixpkgs manual is probably the place to write that down. Similarly for NixOS I suppose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site Improvements to the site infrastructure or content presentation
Projects
None yet
Development

No branches or pull requests

2 participants