chore(API docs): link to related docs pages

[mitchnielsen]

Links from the API docs to the related documentation pages. This helps identify which features each API route represents.

Related to https://linear.app/prefect/issue/PLA-987/add-links-to-documentation-from-the-oss-api-docs

Checklist

• This pull request references any related issue by including "closes <link to issue>"
  • If no issue exists and your change is not a small fix, please create an issue first.
• If this pull request adds new functionality, it includes unit tests that cover the changes
• If this pull request removes docs files, it includes redirect settings in mint.json.
• If this pull request adds functions or classes, it includes helpful docstrings.

[codspeed-hq]

CodSpeed Performance Report

Merging #17276 will not alter performance

_{Comparing backlinks-in-oss-api-docs (c5d885f) with main (27db9ba)}

Summary

✅ 2 untouched benchmarks

[mitchnielsen]

So this seems to work fine from the OSS API docs pages (https://docs.prefect.io/v3/api-ref/rest-api/server/), but I believe these also get ingested into the Cloud API docs pages (https://app.prefect.cloud/api/docs).

The text added in this PR should appear here:

I'm not sure, though, if this markdown link will render as expected so it's a click-able link.

Also, the current change uses relative links, meaning it links back to docs.prefect.io. From the Cloud API docs, this won't work, so we may want to ditch relative links and instead provide the full URL here so it works from both the OSS API docs and the Cloud API docs.

[mitchnielsen]

I tested to make sure the markdown would render in the Cloud API docs, and looks like it will.

Diff with a change (link is wrong, but just used any link to confirm markdown would render):

diff --git a/src/prefect_cloud/nebula/collections.py b/src/prefect_cloud/nebula/collections.py
index aa6df49f1..0b8cf3b29 100644
--- a/src/prefect_cloud/nebula/collections.py
+++ b/src/prefect_cloud/nebula/collections.py
@@ -31,7 +31,11 @@ CollectionViewName = Literal[
 async def read_view_content(
     view: CollectionViewName,
 ) -> Dict[str, Any]:
-    """Reads the content of a view from the prefect-collection-registry."""
+    """
+    Reads the content of a view from the prefect-collection-registry.
+
+    For more information, see [collections](https://docs.prefect.io/v3/develop/blocks).
+    """
 
     try:
         collection_view = await get_collection_view(view)