Skip to content

docs: show a working sample inspection in first-run guide - #39

Merged
bewaterhere-coder merged 2 commits into
mainfrom
docs/show-first-sample-cli-check
Nov 1, 2026
Merged

bewaterhere-coder merged 2 commits into
mainfrom
docs/show-first-sample-cli-check

Conversation

@bewaterhere-coder

Copy link
Copy Markdown
Owner

Summary

  • Add frameforge examples/sample-game-godot to the Chinese and English README quickstart.
  • Add the same first-run sample command to both language sections of the best-practices guide.
  • Position the included Godot sample as the first real CLI inspection before users configure their own project Profile.

Why

The repository already ships a complete sample project with a valid project-owned Profile and standards. The quickstart previously jumped from listing plugins directly to inspecting an arbitrary user project, making new users encounter Profile setup before seeing a working example.

Boundaries

  • Documentation only; no Core, CLI, plugin or Profile behavior changes.
  • No new initialization command or mandatory setup.
  • The sample remains explicitly Candidate and the inspection remains read-only/non-blocking.

Verification

  • Confirmed examples/sample-game-godot exists on the PR branch.
  • Confirmed its .frameforge/profile.json contains an explicit Godot selection and project-relative standards paths.
  • Confirmed both README and best-practices sections contain the command in Chinese and English.

@bewaterhere-coder
bewaterhere-coder merged commit e3e9fb2 into main Nov 1, 2026
6 checks passed
@bewaterhere-coder
bewaterhere-coder deleted the docs/show-first-sample-cli-check branch November 1, 2026 11:43
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