Skip to content

docs: fix getting started steps - #6

Merged
necessarylion merged 1 commit into
mainfrom
todo/cli-readme
Nov 1, 2026
Merged

necessarylion merged 1 commit into
mainfrom
todo/cli-readme

Conversation

@necessarylion

Copy link
Copy Markdown
Member

Problem

The README told users to run cp .env.example .env after dox create. But dox create already makes .env with a new random APP_KEY. The cp step overwrote that file. The app then used the public key from the template.

Fix

  • Removed the cp .env.example .env step.
  • Added one line: dox create makes the .env with a new APP_KEY, so do not copy .env.example over it.
  • Checked the other steps against lib/src/tools/create_project.dart. dox create prints cd <name>, dart pub get, dox serve. The README now has the same steps (dox s is the short name of dox serve).

Checks

  • dart analyze: no issues.
  • dart test: 89 tests pass.

No breaking changes.

The README told users to run "cp .env.example .env" after
"dox create". But "dox create" already makes .env with a new APP_KEY.
The cp step overwrote it with the public key from the template.
The step is gone, and the README now says that "dox create" makes
the .env. The other steps match what "dox create" prints.

No breaking changes.
@necessarylion
necessarylion merged commit 158a079 into main Nov 1, 2026
1 check passed
@necessarylion
necessarylion deleted the todo/cli-readme branch November 1, 2026 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant