[react] feat: Added docs for components/Stats

packages/react/components/Stats/index.mjs

@@ -45,6 +45,14 @@ const option = {
   },
 }
 
+/**
+ * A component to display generic stats from the FreeSewing backend
+ *
+ * @component
+ * @param {object} props - All component props
+ * @param {React.FC} [props.Link = false] - An optional framework-specific Link component
+ * @returns {JSX.Element}
+ */
 export const Stats = ({ Link = false }) => {
   if (!Link) Link = WebLink
   const [stats, setStats] = useState()

packages/react/mkdocs.sh

@@ -35,3 +35,4 @@ jsdoc -c jsdoc.json components/Role/* > ../../sites/dev/prebuild/jsdoc/react/com
 jsdoc -c jsdoc.json components/SignIn/* > ../../sites/dev/prebuild/jsdoc/react/components/signin.json
 jsdoc -c jsdoc.json components/SignUp/* > ../../sites/dev/prebuild/jsdoc/react/components/signup.json
 jsdoc -c jsdoc.json components/Spinner/* > ../../sites/dev/prebuild/jsdoc/react/components/spinner.json
+jsdoc -c jsdoc.json components/Stats/* > ../../sites/dev/prebuild/jsdoc/react/components/stats.json

sites/dev/docs/reference/packages/react/components/stats/readme.mdx

@@ -2,6 +2,24 @@
 title: Stats
 ---
 
-:::note
+
-This page is yet to be created
+import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
-:::
+import { ComponentDocs } from '@site/src/components/component-docs.js'
+import * as jsdoc from '@site/prebuild/jsdoc/components.stats.mjs'
+import { Stats } from '@freesewing/react/components/Stats'
+
+<DocusaurusDoc>
+
+- [Components](#components)
+
+## Components
+
+The **Stats** component family provides the following components:
+
+- [Stats](#stats)
+
+### Stats
+
+<ComponentDocs docs={jsdoc.jsdocStats} example={Stats} />
+
+</DocusaurusDoc>