From 6066f708aa7a251e8feb2b66e1e8dac456466809 Mon Sep 17 00:00:00 2001 From: Sergio Lacaci Date: Wed, 31 Jul 2024 17:20:19 +0200 Subject: [PATCH 1/3] docs - add how to capitalize headings using APA style --- docs/writing-style-guide.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/writing-style-guide.md b/docs/writing-style-guide.md index 54bdc87..dfaa1ca 100644 --- a/docs/writing-style-guide.md +++ b/docs/writing-style-guide.md @@ -1,3 +1,5 @@ +# GoldenDog Linux Documentation Style Guide + To maintain a consistent language and style across our documentation, we use these guidelines. We value your content over strict adherence to formatting rules, so don't worry about mastering the entire style guide before you contribute. However, expect that other contributors might edit your work to match this guide. When you submit a content pull request, reviewers may refer you to these guidelines. ## Consider the Three Cs of Writing @@ -28,7 +30,8 @@ The three Cs of good writing are writing clearly, concisely, and consistently. - **Provide a Descriptive Introduction:** - Ensure the opening paragraph(s) before the first heading summarizes the information covered and what readers can achieve. This helps readers determine if the page is relevant to them. -- **Headings:** Use headings to organize content, starting with the most important information. +- **Headings:** Use headings to organize content, starting with the most important information. Use [this site](https://capitalizemytitle.com/style/APA/) to capitalize headings using APA style. + - **Incorrect:** `

Creating a File

` - **Correct:** `

Creating a File

` From 8d12509717047089e13da672bf232cc9202c7b89 Mon Sep 17 00:00:00 2001 From: Sergio Lacaci Date: Wed, 31 Jul 2024 17:27:38 +0200 Subject: [PATCH 2/3] docs - adapt sidebar items to APA capitalization rules --- docs/_sidebar.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 57399bc..0cf150b 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,32 +1,32 @@ -* Getting started +* Getting Started - [Installing GDL](install-gdl.md) * Documentation - [Burn GDL to USB](create-usb.md) - [System Specs](system-specs.md) - [Extra Downloads](extras-md) -* Information for contribute (Docs) -- [How Contribute](how-contribute.md) - - [Aditional Information](how-contribute.md#aditional-information) +* Information About Contributing (Docs) +- [How to Contribute](how-contribute.md) + - [Additional Information](how-contribute.md#aditional-information) - [- Folders Structure](how-contribute.md#folders-structure) - - [- Sidebar File](how-contribute.md#siderbarmd-file) + - [- Sidebar Files](how-contribute.md#siderbarmd-file) - [- Plugins](how-contribute.md#plugins) - [- Local Server](how-contribute.md#docsify-cli-to-local-server) - - [How to fork](how-to-fork.md) + - [How to Fork](how-to-fork.md) - [- Initial Steps](how-to-fork.md#inital-steps) - [- Create New Branch](how-to-fork.md#create-a-new-branch) - - [- Pull request](how-to-fork.md#make-changes-and-create-a-pull-request) + - [- Pull Requests](how-to-fork.md#make-changes-and-create-a-pull-request) - [- Suggestions](how-to-fork.md#suggestions-for-branch-and-commit-names) - - [Writting Guide](writing-style-guide.md) + - [Writing Guide](writing-style-guide.md) - [- Considerations](writing-style-guide.md#consider-the-three-cs-of-writing) - [- Styles](writing-style-guide.md#writing-style) - [- Structure](writing-style-guide.md#content-structure) - [- Formatting](writing-style-guide.md#formatting) - - [- Tone and voide](writing-style-guide.md#tone-and-voice) + - [- Tone and Voice](writing-style-guide.md#tone-and-voice) - [- Abbreviations](writing-style-guide.md#abbreviations-and-acronyms) - [- Capitalization](writing-style-guide.md#capitalization) - [- Contractions](writing-style-guide.md#contractions) - - [- Numbers and numerals](writing-style-guide.md#numbers-and-numerals) - - [- Links and references](writing-style-guide.md#links-and-references) + - [- Numbers and Numerals](writing-style-guide.md#numbers-and-numerals) + - [- Links and References](writing-style-guide.md#links-and-references) - [- Visuals](writing-style-guide.md#visuals) * Community - [Discord and IRC](socials.md) From 783cf306e664d4cc4849eb69b566a01bb5905276 Mon Sep 17 00:00:00 2001 From: Sergio Lacaci Date: Wed, 31 Jul 2024 18:16:26 +0200 Subject: [PATCH 3/3] docs - add spanish style guide, add items to sidebar and fix a few typos --- docs/es/_sidebar.md | 28 +++++++++++------ docs/es/guia-estilo.md | 70 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+), 10 deletions(-) create mode 100644 docs/es/guia-estilo.md diff --git a/docs/es/_sidebar.md b/docs/es/_sidebar.md index d62713b..47cf8cc 100644 --- a/docs/es/_sidebar.md +++ b/docs/es/_sidebar.md @@ -1,27 +1,35 @@ -* Empezando +* Cómo empezar - [Instalar GDL](instalar-gdl.md) * Documentación - [Grabar GDL en USB](crear-usb.md) - [Especificaciones del sistema](especificaciones-sistema.md) - [Descargas adicionales](extras.md) * Información para contribuir (Doc) -- [Como Contribuir](como-contribuir.md) - - [Informacion Adicional](como-contribuir.md#información-adicional) +- [Cómo contribuir](como-contribuir.md) + - [Información adicional](como-contribuir.md#información-adicional) - [- Estructura de carpetas](como-contribuir.md#estructura-de-carpetas) - - [- Archivo Sidebar](como-contribuir.md#archivo-_sidebarmd) + - [- Archivos del sidebar](como-contribuir.md#archivo-_sidebarmd) - [- Plugins](como-contribuir.md#complementos-plugins) - - [- Docsify Cli](como-contribuir.md#docsify-cli-a-servidor-local) - - [Como hacer Fork](como-hacer-fork.md) - - [- Pasos Iniciales](como-hacer-fork.md#pasos-iniciales) + - [- Docsify CLI](como-contribuir.md#docsify-cli-a-servidor-local) + - [Cómo hacer fork](como-hacer-fork.md) + - [- Pasos iniciales](como-hacer-fork.md#pasos-iniciales) - [- Crear una nueva rama](como-hacer-fork.md#crear-una-nueva-rama) - - [- Pull request](como-hacer-fork.md#realizar-cambios-y-crear-pull-request) + - [- Pull requests](como-hacer-fork.md#realizar-cambios-y-crear-pull-request) - [- Sugerencias](como-hacer-fork.md#sugerencias-para-nombres-de-ramas-y-commits) + - [Guía de estilo](guia-estilo.md) + - [- Uso de mayúsculas en nombres de páginas y encabezados](guia-estilo.md#uso-de-mayúsculas-en-nombres-de-páginas-y-encabezados) + - [- Siglas y abreviaturas](guia-estilo.md#siglas-y-abreviaturas) + - [- Plurales](guia-estilo.md#plurales) + - [- Números](guia-estilo.md#números) + - [- Tratamiendo: Ústed, Tú, y Yo](guia-estilo.md#tratamiento-ústed-tú-y-yo) + - [- Sugerencias](guia-estilo.md#sugerencias) + * Comunidad -- [Discord and IRC](redes.md) +- [Discord y IRC](redes.md) - [Scripts de la comunidad ](scripts-comunidad.md) * Equipos - [Desarrollo](teams-dev.md) - [Web](teams-web.md) - [Testeo](teams-testeo.md) - [Documentación](teams-documentacion.md) -- [Comunidad](teams-comunidad.md) \ No newline at end of file +- [Comunidad](teams-comunidad.md) diff --git a/docs/es/guia-estilo.md b/docs/es/guia-estilo.md new file mode 100644 index 0000000..c889e61 --- /dev/null +++ b/docs/es/guia-estilo.md @@ -0,0 +1,70 @@ +# Guía de Estilo + +Para mantener la documentación organizada, estandarizada y fácil de leer, esta guía describe cómo debe organizarse, escribirse y formatearse el texto. Son pautas, no reglas estrictas. Valoramos más el contenido que el formato, así que no te preocupes por aprenderte toda la guía antes de colaborar. Es posible que otros editen tu trabajo para ajustarlo a esta guía. + +## Uso de mayúsculas en nombres de páginas y encabezados + +- Solo la primera palabra debe empezar con mayúscula. + - **Correcto:** "Guía de estilo" + - **Incorrecto:** "Guía de Estilo" + +## Infinitivos y gerundios + +- En los títulos, usa el infinitivo del verbo en lugar del gerundio. + - **Correcto:** Configurar Firefox + - **Incorrecto:** Configurando Firefox + +## Siglas y abreviaturas + +### Mayúsculas y espacios + +- Escribe las siglas en mayúsculas y sin puntos. + - **Correcto:** XUL + - **Incorrecto:** X.U.L.; Xul + +### Expansión + +- Explica las siglas la primera vez que aparezcan en el texto. + - **Correcto:** "SVG (Gráficos vectoriales escalables) es un lenguaje de marcado XML..." + - **Incorrecto:** "SVG es un lenguaje de marcado XML..." + +- Opcionalmente, usa el elemento `abbr`: + ```html + SVG + +## Plurales + +Para los plurales de siglas, usa "s". +- **Correcto:** CD-ROMs +- **Incorrecto:** CD-ROM's + +## Números + +### Fechas + +Usa el formato: día mes año. +- **Correcto:** 1 de enero de 2006 +- **Incorrecto:** 01/02/06 + +### Cantidades + +Usa coma para separar decimales y punto para indicar miles. +- **Correcto:** 1,5 GB son 1.536 MB +- **Incorrecto:** 1.5 GB son 1536 MB + +## Tratamiento: Usted, Tú y Yo + +### El tuteo + +Este es un problema complejo, puede que no exista la solución perfecta a gusto de todos. Pero sería interesante ponernos de acuerdo. Te invitamos a compartir tus opiniones en nuestro Discord. + +### La 1ª Persona + +Evita usar la primera persona. +- **Correcto:** es recomendable... +- **Incorrecto:** te recomiendo... + +## Sugerencias + +Si ves que falta contenido o crees que deberíamos mejorar o corregir algo, por favor coméntalo en nuestro servidor de Discord. +