docs: add Spanish README - #2
Conversation
WalkthroughSe añade un README en español para un exportador Prometheus de SMC para Macs con Apple Silicon. Incluye métricas, compilación, ejecución, opciones HTTP, endpoint de métricas, configuración de scraping y reconocimientos. ChangesDocumentación del exportador
Estimated code review effort: 1 (Trivial) | ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.es-ES.md`:
- Around line 23-44: Update the execution steps in the Spanish README to satisfy
Markdown linting: use 1. for every numbered item, add blank lines around each
fenced block, label shell fences as bash, and indent the setup command blocks so
they remain part of their list items. Apply the same formatting consistently to
the exporter execution example.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: e78f640b-6319-49aa-bfeb-d51615be4939
📒 Files selected for processing (1)
README.es-ES.md
| 1. Clona el repositorio: | ||
| ``` | ||
| git clone https://github.com/AdeshAtole/smc-exporter.git | ||
| ``` | ||
|
|
||
| 2. Navega al directorio del proyecto: | ||
| ``` | ||
| cd smc-exporter | ||
| ``` | ||
|
|
||
| 3. Compila el exportador: | ||
| ``` | ||
| go build | ||
| ``` | ||
|
|
||
| ## Uso | ||
|
|
||
| Ejecuta el exportador: | ||
|
|
||
| ``` | ||
| ./smc-exporter | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Corrige los errores de Markdown en los pasos de ejecución.
markdownlint-cli2 reporta MD029, MD031 y MD040. Usa 1. en todos los elementos numerados, añade líneas en blanco alrededor de los bloques y especifica bash. Indenta los bloques para mantenerlos dentro de cada paso.
Propuesta de corrección
1. Clona el repositorio:
-```
+ ```bash
git clone https://github.com/AdeshAtole/smc-exporter.git
-```
+ ```
-2. Navega al directorio del proyecto:
-```
+1. Navega al directorio del proyecto:
+
+ ```bash
cd smc-exporter
-```
+ ```
-3. Compila el exportador:
-```
+1. Compila el exportador:
+
+ ```bash
go build
-```
+ ```
-```
+```bash
./smc-exporter
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 24-24: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 28-28: Ordered list item prefix
Expected: 1; Actual: 2; Style: 1/1/1
(MD029, ol-prefix)
[warning] 29-29: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 29-29: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 33-33: Ordered list item prefix
Expected: 1; Actual: 3; Style: 1/1/1
(MD029, ol-prefix)
[warning] 34-34: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 34-34: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 42-42: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.es-ES.md` around lines 23 - 44, Update the execution steps in the
Spanish README to satisfy Markdown linting: use 1. for every numbered item, add
blank lines around each fenced block, label shell fences as bash, and indent the
setup command blocks so they remain part of their list items. Apply the same
formatting consistently to the exporter execution example.
Source: Linters/SAST tools
1 participant
Adds README.es-ES.md alongside the original documentation.
Summary by CodeRabbit