fix: fix review issues

instructure · Nov 23, 2023 · 47808b9 · 47808b9
1 parent 9ecfd9a
commit 47808b9
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 7 deletions.
diff --git a/docs/contributor-docs/writing-docs.md b/docs/contributor-docs/writing-docs.md
@@ -12,7 +12,7 @@ This page documents how to add and maintain documentation.
 
 The documentation site is generated from the **source code** and the `.md` files. There are two types of `.md` files: `README.md` and `named-md-files.md`, under the `docs folder`.
 
-The **source code** is parsed with [JSDoc](https://jsdoc.app/) and it inprocides `type` information for the docs.
+The **source code** is parsed with [JSDoc](https://jsdoc.app/) with the exeption of react components, which are parsed by [react-docgen](https://react-docgen.dev/) and it provides `type` information for the docs.
 
 The docs can be written in `markdown`, with some added flavor, so the docs can handle special code-display cases.
 
@@ -218,7 +218,7 @@ render(<Example />);
 
 ### 4. Multi example
 
-If an example should be shown in `class` and `function` form as well, it needs to be written as a `list` with two items.
+If an example should be shown in `class` and `function` form as well, it needs to be written as a `list` with two items. The first item will be the `class`, the second the `function`.
 
 ````md
 ---
@@ -247,7 +247,7 @@ type: code
     }
   }
 
-  render(<Exmple />)
+  render(<Example />)
   ```
 
 - ```js
@@ -263,7 +263,7 @@ type: code
     )
   }
 
-  render(<Exmple />)
+  render(<Example />)
   ```
 ````
 

diff --git a/packages/__docs__/src/Playground/index.tsx b/packages/__docs__/src/Playground/index.tsx
@@ -47,6 +47,7 @@ import { Preview, PreviewErrorBoundary } from '../Preview'
 import { CodeSandboxButton } from '../CodeSandboxButton'
 import type { PlaygroundProps, PlaygroundState } from './props'
 import { propTypes, allowedProps } from './props'
+import type { MainDocsData } from '../../buildScripts/DataTypes.mjs'
 
 /* eslint-disable max-len */
 const codeIconPath = (
@@ -200,7 +201,11 @@ class Playground extends Component<PlaygroundProps, PlaygroundState> {
     )
   }
 
-  renderPreview = (code: any, themeKey: any, themes: any) => {
+  renderPreview = (
+    code: string,
+    themeKey: string,
+    themes: MainDocsData['themes']
+  ) => {
     const { fullscreen, rtl } = this.state
 
     return (
@@ -280,7 +285,7 @@ class Playground extends Component<PlaygroundProps, PlaygroundState> {
             ) : this.mutliExample() ? (
               this.renderTabPanel(themeKey, themes)
             ) : (
-              this.renderPreview(this.state.code, themeKey, themes)
+              this.renderPreview(this.state.code as string, themeKey, themes)
             )}
 
             {this.state.showCode && this.renderEditor()}

diff --git a/packages/__docs__/src/Preview/props.ts b/packages/__docs__/src/Preview/props.ts
@@ -31,7 +31,7 @@ import type {
 import PropTypes from 'prop-types'
 import type { ComponentStyle, WithStyleProps } from '@instructure/emotion'
 
-import type { MainDocsData } from '../../buildScripts/DataTypes.mts'
+import type { MainDocsData } from '../../buildScripts/DataTypes.mjs'
 
 type PreviewOwnProps = {
   code: string