From e30e35618a6606041f961b3c19731265d652915d Mon Sep 17 00:00:00 2001 From: bd_ Date: Fri, 9 Sep 2022 17:52:40 -0700 Subject: [PATCH] Docs updates --- docs/docs/test.md | 7 ---- docs/docusaurus.config.js | 41 ++++--------------- .../src/components/HomepageFeatures/index.tsx | 17 ++++---- docs/src/pages/index.tsx | 4 +- 4 files changed, 17 insertions(+), 52 deletions(-) delete mode 100644 docs/docs/test.md diff --git a/docs/docs/test.md b/docs/docs/test.md deleted file mode 100644 index be2fd678..00000000 --- a/docs/docs/test.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 2 ---- - -# test - -test \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 8cf5a481..405e3e08 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -6,9 +6,9 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'My Site', - tagline: 'Dinosaurs are cool', - url: 'https://your-docusaurus-test-site.com', + title: 'Modular Avatar', + tagline: 'Drag-and-drop avatar assembly', + url: 'https://modular-avatar.fushizen.net', baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', @@ -78,39 +78,12 @@ const config = { style: 'dark', links: [ { - title: 'Docs', - items: [ - { - label: 'Documentation', - to: '/docs/intro', - }, - ], + label: 'Documentation', + to: '/docs/intro', }, { - title: 'Community', - items: [ - { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', - }, - { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', - }, - { - label: 'Twitter', - href: 'https://twitter.com/docusaurus', - }, - ], - }, - { - title: 'More', - items: [ - { - label: 'GitHub', - href: 'https://github.com/bdunderscore/modular-avatar', - }, - ], + label: 'GitHub', + href: 'https://github.com/bdunderscore/modular-avatar', }, ], copyright: `Copyright © ${new Date().getFullYear()} bd_. Built with Docusaurus.`, diff --git a/docs/src/components/HomepageFeatures/index.tsx b/docs/src/components/HomepageFeatures/index.tsx index 91ef4601..26d2afd3 100644 --- a/docs/src/components/HomepageFeatures/index.tsx +++ b/docs/src/components/HomepageFeatures/index.tsx @@ -10,32 +10,31 @@ type FeatureItem = { const FeatureList: FeatureItem[] = [ { - title: 'Easy to Use', + title: 'Drag and Drop assembly', Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, description: ( <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. + Modular avatar merges components at build time. Never again will you forget to click 'install' or 'uninstall' + when editing your avatar! ), }, { - title: 'Focus on What Matters', + title: 'Organize your animators', Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, description: ( <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. + Split your avatar's FX animator into multiple sub-animators, and merge at runtime. Keep the animation edit + dropdown tidy! ), }, { - title: 'Powered by React', + title: 'Perfect for prefabs', Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, description: ( <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. + Embed modular avatar components in your prefabs to make installation a breeze! ), }, diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 305139fb..a71388f9 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -18,7 +18,7 @@ function HomepageHeader() { - Docusaurus Tutorial - 5min ⏱️ + Documentation @@ -34,7 +34,7 @@ export default function Home(): JSX.Element { description="Description will go into a meta tag in ">
- +
);