Skip to content

Comments

Docs: link server CLI docs and list flags/env vars#174

Merged
shantur merged 2 commits intodevfrom
codenomad/issue-173
Feb 15, 2026
Merged

Docs: link server CLI docs and list flags/env vars#174
shantur merged 2 commits intodevfrom
codenomad/issue-173

Conversation

@codenomadbot
Copy link
Contributor

@codenomadbot codenomadbot bot commented Feb 15, 2026

Closes #173.

What changed

  • Improve top-level README.md "CodeNomad Server" section with:
    • a direct pointer to packages/server/README.md
    • a --help discovery hint
    • a per-project install/run snippet
  • Expand packages/server/README.md with:
    • --help hint
    • "Install locally" section
    • additional CLI flags/env vars that exist in packages/server/src/index.ts but were missing from docs (UI + logging)
    • advanced env vars for dev update checks

Why

  • Make it obvious where to look to run the web UI and discover configuration options (flags/env vars) without having to search the code.

Notes

  • Docs-only change; no runtime behavior changes.

--
Yours,
CodeNomadBot

Make server usage easier to discover from the root README, add local install/run instructions, and document additional CLI flags/env vars for UI and logging.
@shantur
Copy link
Collaborator

shantur commented Feb 15, 2026

@CodeNomadBot

Changes needed in this PR

  1. Dev releases needs its own section
  2. Link server README as link in main README
  3. Reduce the server launch details in main README and ensure its in server README

@codenomadbot
Copy link
Contributor Author

codenomadbot bot commented Feb 15, 2026

Applied the requested doc adjustments and pushed an update to this PR.

What I understood

  • You want dev releases called out in a dedicated section.
  • The main README.md should link (as an actual markdown link) to the server README.
  • The main README.md should be lighter on server launch/install details, with the full details living in the server README.

What changed

  • README.md
    • Link to server docs is now a clickable link: [packages/server/README.md](packages/server/README.md).
    • Removed the longer server install/run block from the main README to keep it high-level.
    • Added a dedicated Dev Releases section with the dev package launch command.
  • packages/server/README.md
    • Renamed/expanded the advanced update section into Dev Releases (Advanced) and included the dev package launch command.

Commit

  • 8c24a7d docs: reorganize server and dev release docs

--
Yours,
CodeNomadBot

@shantur shantur merged commit 4f6c852 into dev Feb 15, 2026
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.

Add the command line arguments/env vars to README (or a separate doc page)

1 participant