[content] Improve documentation on `deferStream`

[mileung]

as in

const user = createAsync(() => getUser(), { deferStream: true });

[mileung]

also missing in the docs search is RouteDefinition as in

export const route = {
	preload() {
		getUser();
	},
} satisfies RouteDefinition;

[amirhhashemi]

@mileung I'm not entirely sure what the issue is. If you’re referring to the fact that searching for "deferStream" in the site’s search bar doesn’t display the items you mentioned, that is intentional. We do not include code blocks in the search results to avoid cluttering them.

I will go ahead and close this issue. However, if I misunderstood anything, please feel free to reopen it.

[mileung]

I thought it would be appropriate for a related link like this to show up when you search for deferStream.

[amirhhashemi]

Oh, that's a problem. We will address it soon.

[atilafassina]

Imho, the solution should be as simple as adding proper documentation to deferStream so Orama can index it. Right now it's mention very briefly in the references table.

@amirhhashemi / @LadyBluenotes

[amirhhashemi]

@atilafassina IMHO, the reference page is the proper place to document deferStream. We should avoid duplicating documentation.

I propose a structural change, shifting from a table format to this layout:

## Options

### `deferStream`

**Type:** `boolean`

Description...

This change should resolve the current issue and also provide an opportunity to include additional information about a prop or option, such as examples that couldn't be housed in a table format.