Skip to content

docs: add note that project folder must be a Git repository - #199

Merged
ncrmro merged 1 commit into
Unsupervisedcom:mainfrom
weisserj:docs/add-git-requirement-note
Feb 3, 2026
Merged

docs: add note that project folder must be a Git repository#199
ncrmro merged 1 commit into
Unsupervisedcom:mainfrom
weisserj:docs/add-git-requirement-note

Conversation

@weisserj

@weisserj weisserj commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Added a note to the Install section clarifying that deepwork install requires a Git repository
  • Added the same note to the Quick Start section for consistency
  • Suggests running git init first if the folder isn't already a repo

This addresses a common point of confusion for new users who try to run deepwork install in a non-Git folder and get an error.

Test plan

  • Verified the README renders correctly with the new notes

The `deepwork install` command requires a Git repository but this wasn't
documented, causing confusion for users who try to install in non-Git folders.
@github-actions

github-actions Bot commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA. ✅
Posted by the DCO Assistant Lite bot.

@weisserj

weisserj commented Feb 3, 2026

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Feb 3, 2026
@ncrmro
ncrmro enabled auto-merge February 3, 2026 22:12
@ncrmro
ncrmro added this pull request to the merge queue Feb 3, 2026
Merged via the queue into Unsupervisedcom:main with commit 074c5f4 Feb 3, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants