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

Show markdown reference for the description block

Abierto
#87 0 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
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
markdown, ruby
Área
frontend

Línea de trabajo

El issue identifica el bloque de descripción como el punto de entrada, pero no indica archivos ni pruebas. Empieza por localizar esa UI y comprobar cómo se renderiza actualmente su contenido Markdown; compara la referencia al pasar el cursor propuesta con la leyenda o documentación de GitHub enlazada. Se considera terminado cuando los usuarios pueden acceder a una referencia básica y concisa de Markdown sin salir del flujo de trabajo de descripción.

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

Descripción

Feature Request

https://ombulabs.atlassian.net/browse/DT-264

Branch/Commit:

Main branch.

Describe the feature:

As a <role name>
I want to see a quick reference of some markdown syntax
So I don't have to look for that in other places

I imagine a small (?) element next to the description that, on hover, shows a quick cheat-sheet of the basic for formatting and code blocks.

Problem:

Currently, if you need some syntax reference, you have to google for it or remember it. Also, for example, 4-space indentation looks better than tripple backtick for code blocks, maybe we can suggest to use the former instead in that cheat-sheet.

Resources:

Here in github, we have this legend below the description block, clicking it takes you to a documentation page, we could also do that, linking to this same documtation maybe if we don't want a custom cheat-sheet.

image

I will abide by the code of conduct

Lenguaje dominante
Ruby
Estrellas
42
Forks
17
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 fastruby/points

Todos los issues de fastruby/points

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.