docs(readme): Propuesta 1 de Readme.md para documentación #1
Conversation
WalkthroughEl archivo Changes
Sequence Diagram(s)(No se genera un diagrama de secuencia debido a la simplicidad de los cambios.) Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[typographical] ~32-~32: Símbolo desparejado: Parece que falta un ‘[’.
Context: ...talación #### Prerequisitos - Node.js (>= 18.0.0) - Term...(ES_UNPAIRED_BRACKETS)
[typographical] ~35-~35: Símbolo desparejado: Parece que falta un ‘]’.
Context: ...ode.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.c...(ES_UNPAIRED_BRACKETS)
🪛 Markdownlint
README.md
41-41: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
45-45: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
49-49: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
53-53: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
60-60: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
64-64: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
68-68: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
72-72: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (4)
README.md (4)
1-19: ¡Excelente presentación del proyecto!La sección del logo y título del proyecto está bien estructurada y proporciona una introducción visual atractiva. Los enlaces necesarios están incluidos y la disposición es clara.
20-24: Descripción clara y concisa del proyectoLa descripción del proyecto EsJS es informativa y comunica eficazmente su propósito y audiencia objetivo. Proporciona una buena introducción para los nuevos usuarios.
Line range hint
96-101: Información final clara y concisaLa sección final que incluye el enlace al editor en línea y la información de la licencia es clara y proporciona datos importantes para los usuarios. No se requieren cambios en esta parte.
🧰 Tools
🪛 LanguageTool
[typographical] ~32-~32: Símbolo desparejado: Parece que falta un ‘[’.
Context: ...talación #### Prerequisitos - Node.js (>= 18.0.0) - Term...(ES_UNPAIRED_BRACKETS)
[typographical] ~35-~35: Símbolo desparejado: Parece que falta un ‘]’.
Context: ...ode.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.c...(ES_UNPAIRED_BRACKETS)
🪛 Markdownlint
41-41: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
45-45: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
49-49: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
53-53: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
60-60: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
64-64: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
68-68: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
72-72: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: null
Bare URL used(MD034, no-bare-urls)
98-98: null
Bare URL used(MD034, no-bare-urls)
Line range hint
1-101: Excelente mejora del README, con pequeños ajustes pendientesEn general, las modificaciones realizadas en el archivo README.md son muy positivas. La documentación ahora es más completa, estructurada y útil para los nuevos usuarios y colaboradores potenciales del proyecto EsJS.
Aspectos destacados:
- Inclusión de un logo y una introducción visual atractiva.
- Descripción clara del propósito del proyecto.
- Instrucciones de instalación detalladas para varios gestores de paquetes.
- Inclusión de un enlace a un tutorial interactivo.
- Pautas de contribución bien definidas.
Los únicos ajustes pendientes son menores y relacionados con el formato:
- Unificar el estilo de las listas usando guiones (-) en lugar de asteriscos (*).
- Formatear correctamente el enlace a la documentación.
Una vez realizados estos pequeños cambios, el README estará en excelentes condiciones y proporcionará una introducción completa y profesional al proyecto EsJS.
🧰 Tools
🪛 LanguageTool
[typographical] ~32-~32: Símbolo desparejado: Parece que falta un ‘[’.
Context: ...talación #### Prerequisitos - Node.js (>= 18.0.0) - Term...(ES_UNPAIRED_BRACKETS)
[typographical] ~35-~35: Símbolo desparejado: Parece que falta un ‘]’.
Context: ...ode.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.c...(ES_UNPAIRED_BRACKETS)
🪛 Markdownlint
41-41: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
45-45: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
49-49: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
53-53: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
60-60: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
64-64: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
68-68: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
72-72: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: null
Bare URL used(MD034, no-bare-urls)
98-98: null
Bare URL used(MD034, no-bare-urls)
| ## Documentación | ||
|
|
||
| Para obtener más información sobre cómo utilizar EsJS, visita la sección de documentación en https://es.js.org/. | ||
|
|
||
| ## Contribuciones | ||
|
|
||
| Las contribuciones son lo que hacen que la comunidad de código abierto sea un lugar increíble para aprender, inspirar y crear. Cualquier contribución que hagas será **agradecida**. | ||
|
|
||
| 1. Haz un fork del proyecto | ||
| 2. Crea tu rama de características (`git checkout -b mejora/MiMejora`) | ||
| 3. Realiza un commit de tus cambios (`git commit -m 'Agregar Mejora'`) | ||
| 4. Haz un push a la rama (`git push origin mejora/MiMejora`) | ||
| 5. Abre un pull request |
There was a problem hiding this comment.
Buenas pautas de contribución, pero con un pequeño problema de formato
Las pautas de contribución son claras y útiles, proporcionando los pasos necesarios para que los colaboradores potenciales se involucren en el proyecto.
Sin embargo, hay un pequeño problema de formato en el enlace de la documentación:
En la línea 84, el enlace a la documentación está como una URL sin formato. Para mejorar la legibilidad y seguir las mejores prácticas de Markdown, por favor, formatea este enlace correctamente.
Aplica el siguiente cambio:
-Para obtener más información sobre cómo utilizar EsJS, visita la sección de documentación en https://es.js.org/.
+Para obtener más información sobre cómo utilizar EsJS, visita la [sección de documentación](https://es.js.org/).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Documentación | |
| Para obtener más información sobre cómo utilizar EsJS, visita la sección de documentación en https://es.js.org/. | |
| ## Contribuciones | |
| Las contribuciones son lo que hacen que la comunidad de código abierto sea un lugar increíble para aprender, inspirar y crear. Cualquier contribución que hagas será **agradecida**. | |
| 1. Haz un fork del proyecto | |
| 2. Crea tu rama de características (`git checkout -b mejora/MiMejora`) | |
| 3. Realiza un commit de tus cambios (`git commit -m 'Agregar Mejora'`) | |
| 4. Haz un push a la rama (`git push origin mejora/MiMejora`) | |
| 5. Abre un pull request | |
| ## Documentación | |
| Para obtener más información sobre cómo utilizar EsJS, visita la [sección de documentación](https://es.js.org/). | |
| ## Contribuciones | |
| Las contribuciones son lo que hacen que la comunidad de código abierto sea un lugar increíble para aprender, inspirar y crear. Cualquier contribución que hagas será **agradecida**. | |
| 1. Haz un fork del proyecto | |
| 2. Crea tu rama de características (`git checkout -b mejora/MiMejora`) | |
| 3. Realiza un commit de tus cambios (`git commit -m 'Agregar Mejora'`) | |
| 4. Haz un push a la rama (`git push origin mejora/MiMejora`) | |
| 5. Abre un pull request |
🧰 Tools
🪛 Markdownlint
84-84: null
Bare URL used(MD034, no-bare-urls)
| <!-- ¿Cómo instalar? --> | ||
| ## Primeros pasos | ||
|
|
||
| ### Instalación | ||
|
|
||
| #### Prerequisitos | ||
|
|
||
| - [Node.js](https://nodejs.org/) (>= 18.0.0) | ||
| - Terminal para ejecutar comandos | ||
| - Editor de código | ||
| - Recomendado: [Visual Studio Code](https://code.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.com/items?itemName=EnzoNotario.vscode-esjs) | ||
|
|
||
| #### Instalación automática | ||
|
|
||
| La forma más fácil de crear un proyecto EsJS es utilizando el siguiente comando, que te guiará en la creación de un proyecto a partir de una plantilla: | ||
|
|
||
| * npm | ||
| ```bash[npm] | ||
| npm create esjs@latest | ||
| ``` | ||
| * pnpm | ||
| ```bash[pnpm] | ||
| pnpm create esjs@latest | ||
| ``` | ||
| * yarn | ||
| ```bash[yarn] | ||
| yarn create esjs@latest | ||
| ``` | ||
| * bun | ||
| ```bash[bun] | ||
| bun create esjs@latest | ||
| ``` | ||
|
|
||
| Una vez que se haya creado el proyecto, puedes ejecutarlo con el siguiente comando: | ||
|
|
||
| * npm | ||
| ```bash[npm] | ||
| npm run dev | ||
| ``` | ||
| * pnpm | ||
| ```bash[pnpm] | ||
| pnpm dev | ||
| ``` | ||
| * yarn | ||
| ```bash[yarn] | ||
| yarn dev | ||
| ``` | ||
| * bun | ||
| ```bash[bun] | ||
| bun run dev | ||
| ``` | ||
| Navega a `http://localhost:3000` para ver el resultado. | ||
|
|
||
| ## Tutorial Interactivo | ||
|
|
||
| Puedes aprender EsJS de forma interactiva en [Aprender.EsJS.dev](https://aprender.esjs.dev/). |
There was a problem hiding this comment.
Instrucciones de instalación detalladas, pero con problemas de formato
Las instrucciones de instalación son completas y cubren varios gestores de paquetes, lo cual es excelente. La inclusión de los prerrequisitos y el enlace al tutorial interactivo son muy útiles.
Sin embargo, hay un problema de consistencia en el formato de las listas:
Por favor, modifica los asteriscos (*) al principio de las listas por guiones (-) para mantener un estilo consistente en todo el documento. Esto afecta a las líneas 41, 45, 49, 53, 60, 64, 68 y 72.
Ejemplo de corrección:
-* npm
+- npmAplica este cambio a todas las instancias mencionadas.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <!-- ¿Cómo instalar? --> | |
| ## Primeros pasos | |
| ### Instalación | |
| #### Prerequisitos | |
| - [Node.js](https://nodejs.org/) (>= 18.0.0) | |
| - Terminal para ejecutar comandos | |
| - Editor de código | |
| - Recomendado: [Visual Studio Code](https://code.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.com/items?itemName=EnzoNotario.vscode-esjs) | |
| #### Instalación automática | |
| La forma más fácil de crear un proyecto EsJS es utilizando el siguiente comando, que te guiará en la creación de un proyecto a partir de una plantilla: | |
| * npm | |
| ```bash[npm] | |
| npm create esjs@latest | |
| ``` | |
| * pnpm | |
| ```bash[pnpm] | |
| pnpm create esjs@latest | |
| ``` | |
| * yarn | |
| ```bash[yarn] | |
| yarn create esjs@latest | |
| ``` | |
| * bun | |
| ```bash[bun] | |
| bun create esjs@latest | |
| ``` | |
| Una vez que se haya creado el proyecto, puedes ejecutarlo con el siguiente comando: | |
| * npm | |
| ```bash[npm] | |
| npm run dev | |
| ``` | |
| * pnpm | |
| ```bash[pnpm] | |
| pnpm dev | |
| ``` | |
| * yarn | |
| ```bash[yarn] | |
| yarn dev | |
| ``` | |
| * bun | |
| ```bash[bun] | |
| bun run dev | |
| ``` | |
| Navega a `http://localhost:3000` para ver el resultado. | |
| ## Tutorial Interactivo | |
| Puedes aprender EsJS de forma interactiva en [Aprender.EsJS.dev](https://aprender.esjs.dev/). | |
| <!-- ¿Cómo instalar? --> | |
| ## Primeros pasos | |
| ### Instalación | |
| #### Prerequisitos | |
| - [Node.js](https://nodejs.org/) (>= 18.0.0) | |
| - Terminal para ejecutar comandos | |
| - Editor de código | |
| - Recomendado: [Visual Studio Code](https://code.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.com/items?itemName=EnzoNotario.vscode-esjs) | |
| #### Instalación automática | |
| La forma más fácil de crear un proyecto EsJS es utilizando el siguiente comando, que te guiará en la creación de un proyecto a partir de una plantilla: | |
| - npm | |
| ```bash[npm] | |
| npm create esjs@latest | |
| ``` | |
| - pnpm | |
| ```bash[pnpm] | |
| pnpm create esjs@latest | |
| ``` | |
| - yarn | |
| ```bash[yarn] | |
| yarn create esjs@latest | |
| ``` | |
| - bun | |
| ```bash[bun] | |
| bun create esjs@latest | |
| ``` | |
| Una vez que se haya creado el proyecto, puedes ejecutarlo con el siguiente comando: | |
| - npm | |
| ```bash[npm] | |
| npm run dev | |
| ``` | |
| - pnpm | |
| ```bash[pnpm] | |
| pnpm dev | |
| ``` | |
| - yarn | |
| ```bash[yarn] | |
| yarn dev | |
| ``` | |
| - bun | |
| ```bash[bun] | |
| bun run dev | |
| ``` | |
| Navega a `http://localhost:3000` para ver el resultado. | |
| ## Tutorial Interactivo | |
| Puedes aprender EsJS de forma interactiva en [Aprender.EsJS.dev](https://aprender.esjs.dev/). |
🧰 Tools
🪛 LanguageTool
[typographical] ~32-~32: Símbolo desparejado: Parece que falta un ‘[’.
Context: ...talación #### Prerequisitos - Node.js (>= 18.0.0) - Term...(ES_UNPAIRED_BRACKETS)
[typographical] ~35-~35: Símbolo desparejado: Parece que falta un ‘]’.
Context: ...ode.visualstudio.com/) con la extensión [EsJS](https://marketplace.visualstudio.c...(ES_UNPAIRED_BRACKETS)
🪛 Markdownlint
41-41: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
45-45: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
49-49: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
53-53: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
60-60: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
64-64: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
68-68: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
72-72: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
|
@AntaresGT me gusta mucho esta propuesta! Aunque este repositorio es específico de la Documentación, y en realidad el repositorio "principal" es https://github.com/es-js/esjs. Ahora veo que esto quizás genera confusión... qué te parece si hacemos los siguientes cambios:
O bien:
Por otro lado, creo que también debemos dejar los README lo más mínimo posible, y en todo caso mejorar el contenido de la Documentación propiamente dicha (es decir, los archivos Markdown dentro de Por ejemplo:
|
Agregar Documentación Adicional al README.md
Descripción
Este pull request incluye cambios en el archivo
README.mdcon el objetivo de proporcionar una documentación más detallada y estructurada para EsJS. Los nuevos cambios brindan una guía clara sobre cómo comenzar con EsJS, cómo instalarlo y ejecutarlo, y enlazan a más recursos interactivos.Se ha añadido una sección de instalación paso a paso con diferentes gestores de paquetes y una sección más detallada sobre contribuciones, brindando una experiencia más completa para los desarrolladores interesados en el proyecto.
Cambios Realizados
README.md.Motivación
El objetivo de estos cambios es mejorar la experiencia del usuario al ingresar al repositorio, proporcionando una visión clara y directa de cómo comenzar a trabajar con EsJS. La nueva estructura del
README.mdpermite a los nuevos colaboradores y usuarios del proyecto tener una referencia clara y completa desde el principio.Al iniciar en el
README.md, se obtiene una visión general del proyecto, así como de los pasos necesarios para instalar y ejecutar EsJS, lo cual facilita la adopción del lenguaje.Instrucciones para Probar los Cambios
README.mdactualizado.Comentarios
Este es un paso inicial para mejorar la documentación del proyecto. A futuro, agregare documentación en Primeros pasos.md considerando agregar más ejemplos de código.
Agradezco cualquier comentario o sugerencia que tengan sobre esta actualización.
Previsualización
Summary by CodeRabbit