Skip to content

Docs: list the taskuary command-line options, and fix the "port is taken" advice #63

Description

@ldbumble

The docs never list the taskuary command's options, and the "port is taken" advice is incomplete.

Where

  • docs/site/*.md never mention --port, --host, --no-browser or --debug (only --done appears)
  • docs/site/troubleshooting.md, "The port is taken", says only to set TASKUARY_PORT. It does not mention --port, or that the CLI already moves to a free port by itself (see taskuary/cli.py)

Done when

  • docs/site/start-here.md has a ## Command-line options section with the everyday flags (--port, --host, --no-browser, --debug), worded from taskuary --help
  • the troubleshooting entry mentions --port and the automatic free port

Test - cd website && npm run build:docs && npm test (website/test/docs.test.mjs checks headings and anchors). Commit the regenerated site/docs/ too.


Getting started: pip install -e ".[dev]", then python -m pytest -q (offline, a few seconds). UI work: cd website && npm ci && npm test. See CONTRIBUTING.md. One small PR with the change and its test is perfect.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions