airvzxf / airvzxf/ftp-deployment-action

docs(readme): extended example has broken YAML indentation (server_dir appears as top-level key)

Ouverte Adaptée aux débutants
#236 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
audit documentation pending-human pending-review priority:medium
Langage dominant
Shell
Étoiles
37
Forks
9
Merge moyen
44 min
PR mergées (30 j)
47

Description

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)"

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github-actions, yaml
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
Active
Clarté
Clairement spécifiée
Accessibilité débutants
90/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.