feat: Remove 404 at "/"

[dan-fernandes]

When interacting with BlueAPI via web browser, the landing page (/) returns a 404.

This has led to other developers having to ask how to access the web-based interface (at /docs).

This PR will have the root page return something meaningful.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.76%. Comparing base (038fe03) to head (c467cd8).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1330   +/-   ##
=======================================
  Coverage   94.76%   94.76%           
=======================================
  Files          42       42           
  Lines        2752     2752           
=======================================
  Hits         2608     2608           
  Misses        144      144           

☔ View full report in Codecov by Sentry.
📢 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.

[dan-fernandes]

Would it be more appropriate to have the docs url be at /, or to have / redirect to /docs?

My concerns are that:

1. We may use / in the future (and still want to docs)
2. I don't know how standardised /docs is, and whether the change would cause more confusion that it's worth

[ZohebShaikh]

I think having / as the docs page is the better option then redirecting /docs to /.
These are my thoughts on your questions

1. I don't think we are planning to host any UI at ixx-blueapi.diamond.ac.uk So using root should be okay.
   But even if we have to host a UI then that UI can have a link to the docs page which can be hosted at any location
2. I think having the docs page at the root is the most natural place for the documentation to live because anyone that goes to "ixx-blueapi.diamond.ac.uk" goes only to find the docs page for blueapi.
   To mitigate this we should inform people on athena channel that this is where the docs page is going to live from now on.
   (I think this will definitely have a positive reaction as you can see for the reaction on module load going to the correct namespace that you need)

[dan-fernandes]

Okay let's go for it.

Should we also have a redirect from the now empty /docs to the new /, or is that overkill?

[ZohebShaikh]

Okay let's go for it.

Should we also have a redirect from the now empty /docs to the new /, or id that overkill?

I think that is overkill

We should also get some opinions from @DiamondLightSource/developers-daq-core

[tpoliaw]

Having / not be a 404 would be great improvement - going through the auth login for p4x and ending up with a not-found is surprising.

Personally I think making / redirect to /docs for now would be the better option so that if we have something else in future at the root it wouldn't render anything that refers to / out of date.

Alternatively it could be a landing page with readme level docs/status on - stuff like current version and where to find other services (tiled/glazed/numtracker) as well as a link to the current jsonapi docs and the general docs.

Not completely against moving the api docs to /, but they should probably still be available at /docs through a redirect (at least for a while) as people are expecting them to be there.