Skip to content

docs(loader): mark --dir as required and describe the watch throttle - #147

Merged
MartinFillon merged 1 commit into
NanoForge-dev:mainfrom
mentallyunstable-lab:docs/dir-required-143
Nov 16, 2026
Merged

MartinFillon merged 1 commit into
NanoForge-dev:mainfrom
mentallyunstable-lab:docs/dir-required-143

Conversation

@mentallyunstable-lab

Copy link
Copy Markdown
Contributor

What does this PR do?

Fixes #143.

  • The -d, --dir rows in README.md, apps/client/README.md and apps/server/README.md said the default is .nanoforge/client / .nanoforge/server. Neither loader sets a default: both throw No game dir specified when --dir is missing (apps/client/src/server.ts, apps/server/src/server.ts). The tables now say required.
  • apps/server/README.md said changes are "debounced to 100 ms". apps/server/src/watch.ts restarts on the first change and ignores further changes for the next 100 ms (a throttle, with no trailing restart). The sentence now says that.

How do you test this PR?

Docs only. The tables keep Prettier's column alignment. Compare the --dir rows with the if (!dir) throw lines and the watch text with watch.ts lines 6-8.

Written with Claude Code (Claude Opus 5.5) and checked by me.

The READMEs gave -d, --dir a default of .nanoforge/client and
.nanoforge/server, but both loaders have no default and throw
"No game dir specified". The server README also said changes are
debounced; the watcher acts on the first change and ignores the next
100 ms.

Closes NanoForge-dev#143

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added app:client Related to client app app:server Related to server app labels Nov 11, 2026

@MartinFillon MartinFillon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi, thanks you for your pr resolving this small issue

@MartinFillon
MartinFillon merged commit 6972ff5 into NanoForge-dev:main Nov 16, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app:client Related to client app app:server Related to server app

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(loader-client,loader-server): the READMEs give --dir a default the code does not have

2 participants