Skip to content

docs: add team usage guide#331

Open
egdev6 wants to merge 2 commits intoGentleman-Programming:mainfrom
egdev6:docs/team-usage-guide
Open

docs: add team usage guide#331
egdev6 wants to merge 2 commits intoGentleman-Programming:mainfrom
egdev6:docs/team-usage-guide

Conversation

@egdev6
Copy link
Copy Markdown
Contributor

@egdev6 egdev6 commented May 5, 2026

🔗 Linked Issue

Closes #305


🏷️ PR Type

  • type:bug — Bug fix
  • type:feature — New feature
  • type:docs — Documentation only
  • type:refactor — Code refactoring (no behavior change)
  • type:chore — Maintenance, dependencies, tooling
  • type:breaking-change — Breaking change

📝 Summary

  • Add a dedicated team-usage guide explaining scope: project vs scope: personal.
  • Document language conventions for shared memory so synced team knowledge stays searchable.
  • Link the new guide from README.md and DOCS.md so teams can find it quickly.

📂 Changes

File Change
docs/TEAM-USAGE.md Added a new guide covering scope mental model, sync boundaries, language strategy, and team workflows
README.md Added a top-level docs link and quick pointer to the new team usage guide
DOCS.md Added the new guide to the technical reference docs table

🧪 Test Plan

  • Unit tests pass locally: go test ./...
  • E2E tests pass locally: go test -tags e2e ./internal/server/...
  • Manually tested the affected functionality

Manual verification:

  • Confirmed the new guide renders as Markdown and is linked from both README.md and DOCS.md.
  • Verified the content covers the issue requirements: scope mental model, language convention, and sync workflow guidance.

🤖 Automated Checks

These run automatically and all must pass before merge:

Check What it verifies Status
Check Issue Reference PR body contains Closes #N / Fixes #N / Resolves #N
Check Issue Has status:approved Linked issue has status:approved label
Check PR Has type: Label* PR has exactly one type:* label
Unit Tests go test ./... passes
E2E Tests go test -tags e2e ./internal/server/... passes

✅ Contributor Checklist

  • I linked an approved issue above (Closes #N)
  • I added exactly one type:* label to this PR
  • I ran unit tests locally: go test ./...
  • I ran e2e tests locally: go test -tags e2e ./internal/server/...
  • Docs updated (if behavior changed)
  • Commits follow conventional commits format
  • No Co-Authored-By trailers in commits

💬 Notes for Reviewers

Copilot AI review requested due to automatic review settings May 5, 2026 08:35
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new documentation page describing how teams should use Engram collaboratively, focusing on the meaning of scope: project vs scope: personal, recommended language conventions for shared memory, and guidance around syncing across teammates/devices. This fits into the broader docs set by filling the “team adoption” gap called out in #305 and making the guide discoverable from the main docs entry points.

Changes:

  • Added docs/TEAM-USAGE.md with a scope mental model, examples, language convention, and workflow guidance.
  • Linked the new guide from the top-level README.md docs nav and quick-start area.
  • Added the guide to the “For other docs” table in DOCS.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
README.md Adds navigation + a quick pointer to the new team usage guide.
docs/TEAM-USAGE.md New team-oriented guide covering scope, language convention, and sync workflow concepts.
DOCS.md Adds the new guide to the docs index table for discoverability.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/TEAM-USAGE.md Outdated
Copy link
Copy Markdown
Collaborator

@Alan-TheGentleman Alan-TheGentleman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for recreating this. The guide fills the right docs gap, but I would not merge it yet.

Two things need fixing first. Add the required type:docs label so the PR passes validation. More importantly, clarify that scope: personal is not currently a sync boundary: project sync exports by project/session association, not by excluding personal scope, so private notes can still replicate if they live in a shared enrolled project.

Once that wording is corrected, this should be good to merge.

@egdev6
Copy link
Copy Markdown
Contributor Author

egdev6 commented May 5, 2026

Addressed the sync clarification in docs/TEAM-USAGE.md.

What changed:

  • Explicitly documented that scope: personal is not currently a sync boundary.
  • Added a warning that project sync exports by project/session association, so personal-scope memories can still replicate if they live in a shared synced project.
  • Added a safe workflow section recommending separate Engram data/storage for team-shared vs private notes until scope-aware sync exists.

I also attempted to add the required type:docs label earlier, but GitHub rejected it because this account does not have label permissions on the upstream repo.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/TEAM-USAGE.md
@egdev6
Copy link
Copy Markdown
Contributor Author

egdev6 commented May 5, 2026

Ready for review!

@egdev6 egdev6 requested a review from Alan-TheGentleman May 6, 2026 07:24
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.

docs: add team usage guide — scope conventions and language strategy for shared memory

3 participants