docs: update files_to_copy examples to newline separator#37
docs: update files_to_copy examples to newline separator#37harris1111 wants to merge 1 commit intomainfrom
Conversation
Align documentation with actions repo change from space to newline separated files_to_copy using YAML block scalar.
SangTran-127
left a comment
There was a problem hiding this comment.
Orochi Standards Review
Issues Found
1. [MEDIUM] New file README-2.md instead of updating existing README.md
The PR creates a brand new README-2.md (292 lines) alongside the existing README.md. This is confusing — which one is the source of truth? If this is a full replacement, update README.md directly. If it's a draft, name it clearly (e.g., README-draft.md) and include a follow-up plan.
2. [LOW] docs/dockerfile-generator.md missing trailing newline
The file ends without a trailing newline — minor but triggers lint warnings in most editors.
What Looks Good
- Comprehensive documentation — the
README-2.mdanddocs/dockerfile-generator.mdare well-structured with tables, examples, and clear sections - Examples updated to use the new
files_to_copyYAML block scalar format - GitHub Actions usage documented with both composite action and reusable workflow examples
- Template configuration table clearly shows builder vs runner defaults
Notes
- Commit title
docs: update files_to_copy examples to newline separatoruses conventional format — good - Consider merging
README-2.mdcontent intoREADME.mdbefore shipping
Reviewed against Orochi standards: code-review-standards.md, git-model.md
chiro-hiro
left a comment
There was a problem hiding this comment.
The documentation content itself is accurate and well-written — the files_to_copy newline format is correctly shown in all examples, no sensitive values are exposed, and the overall structure is a clear improvement.
Two things to fix before this can be approved:
-
README-2.mdmust replaceREADME.md, not sit alongside it. GitHub servesREADME.mdas the repo homepage —README-2.mdwon't be seen. Please rename or copy the content intoREADME.mdand deleteREADME-2.md. This was flagged by SangTran-127 as well. -
docs/dockerfile-generator.mdis missing a trailing newline (visible as\ No newline at end of filein the diff). Please add one.
Once these are addressed this is good to merge.
Summary
files_to_copyDepends on: orochi-network/actions PR