Implement DocSearch in Quick Actions Modal

[JonnyBurger]

🎃 This issue is part of our Hacktoberfest campaign!
📚 Read more about Hacktoberfest here
⏲️ This issue is currently assigned to @uragirii!
💰 Thanks to CodeChem for sponsoring this issue!

I have implemented a Quick Switcher for Remotion, that can be invoked with Cmd+K / Ctrl+K:

It currently imports two modes:

1. If you enter a string, it shows a list of compositions that match this query.
2. If you enter a string and prefix it with "> ", it shows actions that can be taken from a menu:

This task is about implementing a third mode that allows you to find a Documentation page for Remotion.

The following request:

const query = "spring"
await fetch(
	'https://plsduol1ca-dsn.algolia.net/1/indexes/*/queries?x-algolia-agent=' +
		encodeURIComponent('Remotion Preview DocSearch') +
		'&x-algolia-api-key=3e42dbd4f895fe93ff5cf40d860c4a85&x-algolia-application-id=PLSDUOL1CA',
	{
		headers: {
			'content-type': 'application/x-www-form-urlencoded',
		},
		body: JSON.stringify({
			requests: [
				{
					query,
					indexName: 'remotion',
					params:
						'attributesToRetrieve=["hierarchy.lvl0","hierarchy.lvl1","hierarchy.lvl2","hierarchy.lvl3","hierarchy.lvl4","hierarchy.lvl5","hierarchy.lvl6","content","type","url"]&attributesToSnippet=["hierarchy.lvl1:10","hierarchy.lvl2:10","hierarchy.lvl3:10","hierarchy.lvl4:10","hierarchy.lvl5:10","hierarchy.lvl6:10","content:10"]&snippetEllipsisText=…&highlightPreTag=<mark>&highlightPostTag=</mark>&hitsPerPage=20&facetFilters=[]',
				},
			],
		}),
		method: 'POST',
	}
).then((res) => res.json());

will return documentation results for spring.

Acceptance criteria

• Implement a third mode in the Quick Actions modal to find documentation pages based on a query. It does not have to support nesting as Algolia DocSearch, but you can take inspiration from it:

• Do not introduce new dependencies, keep it minimalistic and rather have fewer features than introduce much complexity
• Make it so that you can prefix any query with "? " to switch to the DocSearch mode, similar to how you can enter > to search for Actions.

---

IssueHunt Summary

uragirii has been rewarded.

Backers (Total: $223.00)

• remotion-dev ($223.00)

Submitted pull Requests

• #1444 Add DocSearch in Quick Actions

---

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

[issuehunt-oss]

@remotion-dev has funded $223.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[uragirii]

Can I work on this?

[issuehunt-oss]

@jonnyburger has rewarded $200.70 to @uragirii. See it on IssueHunt

• 💰 Total deposit: $223.00
• 🎉 Repository reward(0%): $0.00
• 🔧 Service fee(10%): $22.30