docs: add .squad directory explainer to first-session guide#290
Open
diberry wants to merge 1 commit intobradygaster:mainfrom
Open
docs: add .squad directory explainer to first-session guide#290diberry wants to merge 1 commit intobradygaster:mainfrom
diberry wants to merge 1 commit intobradygaster:mainfrom
Conversation
Closes bradygaster#289 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Author
|
@bradygaster — PR is ready for review. Adds a quick-reference table to the first-session guide explaining what's inside .squad/ and confirming users can edit + commit those files. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Adds a 'What's inside .squad/?' section to the First Session guide, giving new users a quick reference for the files and directories Squad creates.
Changes
After the line where Squad creates the .squad/\ directory, a new subsection explains:
Also confirms that users can and should edit these files, and that they should be committed to version control.
Context
New users weren't sure what the .squad/\ directory contained or whether they should touch it. This explainer builds confidence right at the moment the directory is created.
Closes #289
Suggested reviewers: @diberry, @bradygaster