Mehdi Raza Jaffery thehappybug

Docusaurus Site SEO Checklist

Basic SEO checklist when working with Docusaurus

Set title, description and keywords for every page. See how to set this in the frontmatter.
Make sure all pages have human-readable links. Docusaurus is quite intuitive about how links are made but you can still read about it in more detail.

Between the title, description, your pages' links and the pages' content, you have 80% of your SEO covered.

Extended SEO Guidelines

Create FAQs for Product Release/Changelog/RFCs/Document

I find this prompt useful when I need to quickly come up with some basic FAQs to include as part of my document. I use this format with Google Gemini inside Google Docs quite frequently:

Format:

[Product or company context].

[Document context].

	import * as React from "react";
	import { AppContextInterface, withAppContext } from "./AppContext";

	const PostInfoComp = ({ appContext }: { appContext?: AppContextInterface }) =>
	appContext && (
	<div>
	Name: {appContext.name} <br />
	Author: {appContext.author} <br />
	Url: {appContext.url}
	</div>

	// This function takes a component...
	export function withAppContext(Component) {
	// ...and returns another component...
	return function ComponentBoundWithAppContext(props) {
	// ... and renders the wrapped component with the current context!
	// Notice that we pass through any additional props as well
	return (
	<AppContextConsumer>
	{appContext => <Component {...props} appContext={appContext} />}
	</AppContextConsumer>

	declare module 'react-fuzzy-picker' {
	import * as React from 'react';

	export interface FuzzyPickerProps<T> {
	label?: string;
	displayCount?: number;
	cycleAtEndsOfList?: boolean;
	onChangeHighlightedItem?: (choice: T) => void;
	isOpen: boolean;
	onClose: () => void;

	// WITHOUT COLLECT PARAMS
	export class PaymentsApi extends BaseApi {
	async listPayments(
	beginTime?: string,
	endTime?: string,
	sortOrder?: string,
	cursor?: string,
	locationId?: string,
	total?: number,
	last4?: string,

	paths:
	"/products":
	get:
	parameters:
	- name: latitude
	in: query
	description: Latitude component of location.
	required: true
	style: form
	- name: longitude

	Profile:
	title: Profile
	required:
	- middle_name
	- rider-id
	type: object
	properties:
	first_name:
	type: string
	description: First name of the Uber user.

	{
	"name": "Thor",
	"universe": "Marvel",
	}