"Watch" vs alternative verbiage in Makefile.

Open Beginner friendly
#604 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Open docs/Makefile at the linked line 30 and review the command currently labeled “Watch.” Update the label to describe that it serves, previews, and automatically rebuilds on changes; the issue is done when the wording makes the command’s behavior clear to contributors.

Written by the indexing model from the issue text.

Description

https://github.com/canonical/sphinx-stack/blob/c549bf4c049f874c409ff9ee77928be83f10303a/docs/Makefile#L30

Consider better, more descriptive wording with respect to the verb "watch" -- "Serve, Preview, and Auto-rebuild on change"; This will help to more clearly describe what a contributor might expect to see when running this command. For me, at least, "watch" was very confusing.

Dominant language
No language data
Stars
37
Forks
77
Avg merge
7d 46m
Merged PRs (30d)
2

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.

More from canonical/sphinx-stack

All issues in canonical/sphinx-stack

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.