Skip to content

docs(settings): correct project storage descriptions - #459

Open
SaKaNa-Y wants to merge 3 commits into
devframes:mainfrom
SaKaNa-Y:docs/project-settings-storage
Open

SaKaNa-Y wants to merge 3 commits into
devframes:mainfrom
SaKaNa-Y:docs/project-settings-storage

Conversation

@SaKaNa-Y

@SaKaNa-Y SaKaNa-Y commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The Scoped Context guide and editor documentation direct authors to workspace storage for settings.project files. These files use project storage.

Correct both descriptions and the type comment's scope:

- per-workspace state under workspace storage
+ per-checkout state under project storage

Evidence

The rebuilt type declaration describes per-checkout state under project storage, matching the guide and implementation.

pnpm lint, pnpm knip, CI=1 pnpm test, pnpm typecheck, and pnpm build passed for the final wording.

Merge Danger

Door: Two-way. Documentation and type comments only.

Blast Radius: Documentation. Storage paths, runtime behavior, and saved data stay unchanged.

@vercel

vercel Bot commented Oct 25, 2026

Copy link
Copy Markdown

@SaKaNa-Y is attempting to deploy a commit to the NuxtLabs Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

github-actions Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

👁️‍🗨️ Review this pull request with grouped, summarized diffs at:
👉 https://pulls.review/gh/devframes/devframe/459?from=github-actions[bot]

raw result

💭 analyzed by vercel-ai-gateway/anthropic/claude-sonnet-5
🕰️ 2026-10-26 04:49 UTC
🔗 head 36a2d15
🤖 automated by pulls.review

{
  "headSha": "36a2d159bed071b4a1f72fb9d1faa334f06e8a89",
  "result": {
    "overallSummary": "Documentation-only fix correcting the storage scope description for `settings.project` (from `workspace` to `project`) in both the Scoped Context guide and the corresponding TypeScript type comment.",
    "groups": [
      {
        "key": "docs-fix",
        "label": "Fix storage docs/comments",
        "summary": "Corrects documentation and a type comment that incorrectly described `settings.project` as using `workspace` storage; it actually uses `project` storage. No code behavior changes.",
        "category": "docs",
        "filePaths": [
          "docs/content/1.guide/7.scoped-context.md",
          "packages/devframe/src/types/scope.ts"
        ]
      }
    ],
    "schemaVersion": 1,
    "source": "llm",
    "generatedAt": "2026-10-26T04:49:47.358Z",
    "model": "vercel-ai-gateway/anthropic/claude-sonnet-5",
    "locale": "en"
  }
}

@SaKaNa-Y
SaKaNa-Y marked this pull request as ready for review October 26, 2026 04:50
@SaKaNa-Y

Copy link
Copy Markdown
Contributor Author

This PR corrects the documentation about where project settings are stored.

@SaKaNa-Y
SaKaNa-Y marked this pull request as draft October 26, 2026 04:55
@SaKaNa-Y
SaKaNa-Y marked this pull request as ready for review October 26, 2026 04:57

This branch has not been deployed

No deployments
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.

1 participant