airvzxf / airvzxf/ftp-deployment-action
docs(readme): extended example has broken YAML indentation (server_dir appears as top-level key)
- Dominant language
- Shell
- Stars
- 37
- Forks
- 9
- Avg merge
- 44m
- Merged PRs (30d)
- 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)"
Contributor guide
No contributing guide indexed for this repository
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 90/100