airvzxf / airvzxf/ftp-deployment-action
docs(readme): extended example has broken YAML indentation (server_dir appears as top-level key)
- Lenguaje dominante
- Shell
- Estrellas
- 37
- Forks
- 9
- Merge medio
- 44 min
- PR fusionados (30 d)
- 47
Descripción
gh issue create --title "docs(readme): extended example has broken YAML indentation (server_dir appears as top-level key)" --label "documentation,audit,priority:medium" --body "## Finding
README.md's extended example section has a YAML block where server_dir (or another key) is mis-indented; it appears as a top-level key instead of under with:. The example is what most users copy-paste; broken indentation silently breaks their workflow.
## Affected code
- README.md — extended example
## Reproduction
1. Read README.md; inspect the extended example.
## Suggested fix
Re-indent the YAML block so all input keys are under `with:`. Validate with `yamllint` or a YAML-aware linter.
## Source
F2 audit 2026-09-03 (docs audit). Reporter: subagent-pekodbj7.
## Related
- Part of EPIC #[epic-number]
- Closes: #NONE (no existing issue)"
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Open README.md and inspect the extended example's YAML block, focusing on the server_dir entry and the with: section. Run yamllint or another YAML-aware linter against the example. Done means all input keys are nested under with: and the example validates without indentation errors.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- github-actions, yaml
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Estado de actividad
- Activo
- Claridad
- Bien especificado
- Aptitud para principiantes
- 90/100