The docs review on superplanehq/superplane#5358 flagged that documentation updates are required.
Source PR: superplanehq/superplane#5358
Requested by: @AleksandarCole via /docs-agree
AI Analysis
Docs Impact Review
This PR introduces a new "From file" command source for the SSH Command component, allowing scripts stored in the app's Files repository to be run over SSH — but the Files concept page still describes the repository as containing only canvas.yaml and console.yaml, leaving users no way to discover or understand the workflow for using their own scripts.
Suggested docs updates:
docs/concepts/files — Update the "What's in the repository" section to clarify that users can add their own files (e.g. shell scripts) beyond canvas.yaml and console.yaml. Add a brief note explaining that custom files are accessible to components like SSH Command via the From file command source option, and that they follow the same draft/publish flow as the YAML files.
Why: The SSH Command component now reads scripts directly from the app's git repository at execution time, making user-uploaded files meaningfully useful for the first time. The current Files page table lists only the two framework-managed YAML files, which creates a docs gap: a user trying to use the new "From file" mode would consult the Files page, find no mention of custom scripts, and have no path forward. The SSH component reference page itself will auto-update from the inline Go docs, but the concept-level workflow (add script to Files tab → reference from SSH node) is not covered anywhere.
The docs review on superplanehq/superplane#5358 flagged that documentation updates are required.
Source PR: superplanehq/superplane#5358
Requested by: @AleksandarCole via
/docs-agreeAI Analysis
Docs Impact Review
This PR introduces a new "From file" command source for the SSH Command component, allowing scripts stored in the app's Files repository to be run over SSH — but the Files concept page still describes the repository as containing only
canvas.yamlandconsole.yaml, leaving users no way to discover or understand the workflow for using their own scripts.Suggested docs updates:
docs/concepts/files— Update the "What's in the repository" section to clarify that users can add their own files (e.g. shell scripts) beyondcanvas.yamlandconsole.yaml. Add a brief note explaining that custom files are accessible to components like SSH Command via the From file command source option, and that they follow the same draft/publish flow as the YAML files.Why: The SSH Command component now reads scripts directly from the app's git repository at execution time, making user-uploaded files meaningfully useful for the first time. The current Files page table lists only the two framework-managed YAML files, which creates a docs gap: a user trying to use the new "From file" mode would consult the Files page, find no mention of custom scripts, and have no path forward. The SSH component reference page itself will auto-update from the inline Go docs, but the concept-level workflow (add script to Files tab → reference from SSH node) is not covered anywhere.