GitbookIO / GitbookIO/integrations

Clarify dev command in CLI to direct you to dev space

Open
#282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cli
Dominant language
TypeScript
Stars
131
Forks
96
Avg merge
7h 8m
Merged PRs (30d)
31

Description

A big QOL improvement would be updating the messaging in the CLI to output the URL to the space you're working in, instead of the server port the server is running on, as going to the server port listed (in a browser) will crash the dev server. It's noted in the docs but adding this to the DX would be a much nicer experience.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CLI's dev command and the messaging that currently prints the server port. Update the output to show the URL for the space being worked in, and verify that following the displayed URL no longer directs users to the server port that crashes the dev server.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.