Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[Enhancement]: Fix the explanation of the V2 Job specs to be more instructive

Abierto
  • ¿Algo no está bien?
#778 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Comience por la sección shared-fields de la documentación de V2 Job, especialmente por las explicaciones de DAG, la sintaxis DOT y observationSource. Revise si cada concepto ayuda a los usuarios a crear y añadir un Job rápidamente; se considera terminado cuando la guía es práctica, enlaza a recursos claros cuando es necesario y evita una carga cognitiva innecesaria.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Chainlink Nodes enhancement
What would you like us to improve?

In this section: https://docs.chain.link/docs/jobs/#shared-fields

  • Reference to DAGs (Directed Acyclical Graphs) are computer science implementation details that may not be relevant to the user? If we are including them it needs to further their ability to quickly implement Jobs and not just educate them on the inner workings of job specs. At the very least they should be linked to the most clear, easily digestible link we can find to explain what they are but then we need to also explain why it matters that pipelines need to be acyclical, why the way they're processed by the Node makes them a directed graph vs undirected graph, etc etc. May not be immediately necessary nor useful for the target audience?
  • I am not familiar with DOT syntax, and perhaps we need to link to an easily consumable resource on what that is. If we link users to something like this we will quickly lose them in a rabbit hole and they are not likely to achieve their goal of getting a job up and running.
  • the explanation under observationSource also encourages the reader to see below on info on writing pipeline DAGs. Cannot see any obvious resource? If users google what chainlink Jobs are and land on this page, they would need more actionable information for quick outcomes, that do not add to cognitive load with new concepts and terms.
How important it is?

Very important if the objective of this page is to get a user to have a Job specified and added to their Node asap. The focus should be on what is necessary and sufficient to get them to that outcome, and eliminate "nice to haves".

Lenguaje dominante
MDX
Estrellas
527
Forks
480
Merge medio
1 d 6 h
PR fusionados (30 d)
111

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de smartcontractkit/documentation

Todos los issues de smartcontractkit/documentation

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.