Added TODOs for docs

Author: matthewlipski

docs/app/layout.config.tsx

@@ -95,6 +95,7 @@ export const baseOptions: Partial<DocsLayoutProps & HomeLayoutProps> = {
   sidebar: {
     tabs: [
       {
+        // TODO: These icons are too small in the mobile view.
         icon: (
           <FaBook className="border-fd-primary text-fd-primary bg-fd-primary/10 h-5 w-5 rounded-sm border p-0.5" />
         ),

docs/components/CustomDocsLayout.tsx

@@ -94,6 +94,8 @@ export function CustomDocsLayout({
       : undefined,
   );
 
+  // TODO: The scroll container for the sidebar is slightly too tall and gets cut off
+  // at the bottom.
   const sidebar = sidebarComponent ?? (
     <>
       {sidebarCollapsible ? <CollapsibleControl /> : null}

docs/content/docs/features/blocks/embeds.mdx

@@ -39,6 +39,7 @@ type ImageBlock = {
 A file block is a block that displays a file.
 
 **Type & Props**
+{/* TODO: Prop descriptions are missing. Also this should probably come before the image blocks. */}
 
 ```ts
 type FileBlock = {

docs/content/docs/features/blocks/list-types.mdx

@@ -36,6 +36,7 @@ type BulletListItemBlock = {
 A numbered list item is a list item that is numbered.
 
 **Type & Props**
+{/* TODO: We should add the `start` prop. */}
 
 ```typescript
 type NumberedListItemBlock = {
@@ -52,6 +53,7 @@ type NumberedListItemBlock = {
 A check list item is a list item that can be checked or unchecked.
 
 **Type & Props**
+{/* TODO: We explain the heading block's `level` prop but don't explain the `checked` prop here. IMO they are both pretty self explanatory, so maybe we should either add an explanation here or remove it there. */}
 
 ```typescript
 type CheckListItemBlock = {

docs/content/docs/features/blocks/typography.mdx

@@ -8,6 +8,7 @@ imageTitle: Typography
 
 Typography blocks are fundamental elements for displaying text content in your documents. BlockNote supports various typography blocks to help you structure and format your content effectively.
 
+{/* TODO: Not 100% sure if we want to include this demo for all subpages. */}
 <Example name="basic/default-blocks" />
 
 ## Paragraph

docs/content/docs/features/custom-schemas/custom-blocks.mdx

@@ -59,6 +59,8 @@ type BlockConfig = {
 };
 ```
 
+{/* TODO: I think with the fumadocs styles, this looks a little wonky as the `type`, `content`, etc fields are not emphasized much. */}
+
 **`type`**
 
 Defines the identifier of the custom block.

docs/content/docs/foundations/document-structure.mdx

@@ -54,6 +54,8 @@ The `content` field of a block contains the rich-text content of a block. This i
 
 The `InlineContent` type is used to describe a piece of inline content:
 
+{/* TODO: Technically there's also custom inline content which has its own type. Blocks share a type regardless of if they're custom or default, but inline content doesn't so this is potentially kind of misleading. */}
+
 ```typescript
 type Link = {
   type: "link";
@@ -76,6 +78,7 @@ The `styles` property is explained below.
 
 The `styles` property of `StyledText` objects is used to describe the rich text styles (e.g.: bold, italic, color) or other attributes of a piece of text. It's a set of key / value pairs that specify the styles applied to the text.
 
+{/* TODO: Wrong link. */}
 See the [Default Schema](/docs/foundations/schemas) to learn which styles are included in BlockNote by default.
 
 ## See it for yourself

docs/content/docs/foundations/manipulating-content.mdx

@@ -131,6 +131,7 @@ editor.setSelection(startBlockId, endBlockId);
 
 1. **Work with block references** - Use existing blocks as references for positioning new blocks
 2. **Handle errors gracefully** - Operations can fail if blocks don't exist or are invalid
+   {/* TODO: This section reads really nicely, with the one caveat being that this page doesn't introduce transactions so the 3rd point is a bit out of nowhere. */}
 3. **Group related operations** - Use transactions to group multiple block changes into a single undo/redo operation
 4. **Consider user experience** - Think about how your block manipulations affect the user's workflow
 

docs/content/docs/foundations/schemas.mdx

@@ -10,6 +10,7 @@ Schemas are the core of how BlockNote works. They are the basic building blocks
 
 The schema is a collection of definitions for the different types of blocks, inline content, and styles that can be used in the editor.
 
+{/* TODO: I feel like this page has a lot of duplicated content with the Custom Schemas page. Maybe we should just link there instead? */}
 <Callout type="info">
   If you are using the default blocks, inline content, and styles, you do not
   need to specify a schema, since we use the default which uses the default

docs/content/docs/getting-started/editor-setup.mdx

@@ -37,6 +37,8 @@ The hook takes two optional parameters:
 
 **options:** Configure the editor with options like (see [Editor Options](/docs/reference/editor/overview#options) for all options):
 
+{/* TODO: Might be more relevant to e.g. switch out `domAttributes` and `tabBehaviour` to `uploadFile` and `pasteHandler`. */}
+
 - `initialContent` - Set starting content
 - `domAttributes` - Add HTML attributes to editor elements. See [Adding DOM Attributes](/docs/react/styling-theming/adding-dom-attributes) for more.
 - `dictionary` - Customize text strings for localization. See the [Localization](/docs/features/localization) for more.