feat: add docs for justfile

[ZohebShaikh]

just --list
Available recipes:
    compose +ARGS="up -d --no-recreate" # Bring up the example services with docker/podman compose
    coverage                            # Run unit tests with coverage and open the HTML report
    default                             # Start the example services via compose and run the blueapi server
    init-example-services               # Clone the example-services submodule if needed but leave it alone otherwise
    lint                                # Regenerate schemas, run pre-commit checks and type checking
    repl                                # Start an interactive REPL logged in to a blueapi client
    run PLAN PARAMS                     # Run a plan against the blueapi controller
    serve *OPTS                         # Run the blueapi server against the system test config
    system *OPTS                        # Run the system test suite
    unit *OPTS="-n logical"             # Run the unit test suite

Shows docs. I have example a vscode plugin which has made some spacing changes.

I have also added just to completion in dev-container for ease of use

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.34%. Comparing base (d55ed6e) to head (615acd1).

Additional details and impacted files

@@              Coverage Diff              @@
##           justfile-fix    #1648   +/-   ##
=============================================
  Coverage         96.34%   96.34%           
=============================================
  Files                46       46           
  Lines              3666     3666           
=============================================
  Hits               3532     3532           
  Misses              134      134           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[tpoliaw]

The docs are good, thanks for adding them, mainly insure what should be here vs in the upstream projects.

[tpoliaw]

Was there a reason for preferring the [doc(...)] format over the plain comment docstring approach?

[doc('comment here')]
recipe:
   ...

vs

# comment here
recipe:
    ...

[ZohebShaikh]

Was there a reason for preferring the [doc(...)] format over the plain comment docstring approach?

Yes I personally like to make it explicit it is for documentation. Can use the docstring if you prefer it.

When I was going through the docs There where a lot of, if you do it this way the docstring will come, if you do it this way it wont and doc approach was the one which had the least cognitive load in my mind

[tpoliaw]

No strong preference either way