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

Term list /glossary

Abierto
#652 12 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
rust

Línea de trabajo

Start by reading the glossary and documentation structure in the Rodio repository; the issue does not name specific files or tests. Identify terms for audio pipeline or tree steps, their relationships, and what consumes them, then add a glossary section that helps contributors use those terms consistently.

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

Descripción

enhancement

Rodio has more contributors 🎉 and the maintenance team is growing stronger 🥳. Communication and documentation efforts are harder then they have to be because we do not have words for every concept in rodio.

My goal is to build a glossary (specialized term list) and make that part of the documentation. We could make the docs link to that glossary each time one of its specialized terms is used.

It seems most urgent to get some words around the audio... pipelines?:

let thing = Decoder::new("path").amplify().pausable()

what do we call each of these steps and how they relate to each-other?

Lets give the steps names so we can discuss this more easily:

let decoder = Decoder::new();
let amplified = decoder.amplify();
let pausable = amplified.pausable();

This is an audio pipeline, but it could also be an audio tree (if we introduce mix). I think we need a words for

  • the thing that generates the samples on one end of the pipeline/tree. Maybe it should be called the generator?
  • referring to an earlier or later step in the pipeline/tree. Concretely is pausable, which is applied after amplify, the parent of amplify or its child? Maybe some other word works? And what is called the other way round?
  • things that these pipelines are fed to. When this pipeline is consumed by something, what do we call it? consumer? It could also be called a Sink as that word will be freed up once we deprecate the Sink struct.
Lenguaje dominante
Rust
Estrellas
2.5k
Forks
338
Merge medio
1 d 3 h
PR fusionados (30 d)
1

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 RustAudio/rodio

Todos los issues de RustAudio/rodio

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.