Insufficient links between guide and reference level docs makes splitting challenging
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza revisando los materiales de nivel de guía y referencia en nix.dev, junto con la documentación relacionada de Nix y nixpkgs, para identificar dónde falta navegación. Se considera terminado cuando los conceptos relevantes tienen enlaces entre las guías, las páginas de referencia y el uso de nixpkgs, y cualquier orientación sobre enlaces queda recogida en la guía de estilo.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Nix
- Estrellas
- 4k
- Forks
- 343
- Merge medio
- 20 h 27 min
- PR fusionados (30 d)
- 10
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NixOS/nix.dev
-
site
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 76/100
NixOS/nix.dev#1224 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
Los mantenedores suelen responder en 1 día
-
FAQ (idea draft)Abiertosite
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
site
Dificultad 5/5 Más de una semana Aptitud para principiantes 38/100
Los mantenedores suelen responder en 1 día
Todos los issues de NixOS/nix.dev
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
bug
Dificultad 1/5 1-3 horas Aptitud para principiantes 83/100
obsidianmd/obsidian-help#1164 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
OAuth documentation for GET /api/v2/users/me/ appears inconsistent with required global read scopeAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día