From 240d306ce3497713c95205c76e93b5f58bc59e55 Mon Sep 17 00:00:00 2001 From: theojungle Date: Thu, 19 Oct 2023 14:44:46 +0200 Subject: [PATCH] chore: remove old documentation and upgrade linters --- .circleci/config.yml | 25 +- .eslintignore | 1 - .gitignore | 2 - .npmignore | 2 +- README.md | 2 - docs/babel.config.js | 17 - docs/components/App.js | 51 - docs/components/Colors.js | 57 - docs/components/ComponentsList/Link.js | 37 - .../ComponentsList/VersionSelector/index.js | 29 - docs/components/ComponentsList/index.js | 73 -- docs/components/ComponentsList/items.js | 78 -- docs/components/ComponentsList/styles.js | 51 - docs/components/Footer.js | 48 - docs/components/GlobalStyle.js | 60 - docs/components/Head.js | 53 - docs/components/Header/NavBar/index.js | 44 - docs/components/Header/NavBar/styles.js | 51 - docs/components/Header/ThemeSelector.js | 60 - docs/components/Header/index.js | 91 -- docs/components/Header/styles.js | 54 - docs/components/Homepage/Components.js | 124 -- docs/components/Homepage/Expectations.js | 95 -- docs/components/Homepage/Section.js | 13 - docs/components/Homepage/Stats.js | 84 -- docs/components/HookForm.js | 51 - docs/components/IconsList/Item.js | 31 - docs/components/IconsList/Item.styles.js | 41 - docs/components/IconsList/icons.js | 315 ----- docs/components/IconsList/index.js | 61 - docs/components/Illustration404.js | 13 - docs/components/Layouts/Docs/index.js | 30 - docs/components/Layouts/Docs/styles.js | 38 - docs/components/Layouts/index.js | 39 - docs/components/Logo.js | 25 - docs/components/LogoWttj.js | 15 - docs/components/Mdx/Code/CopyButton.js | 20 - docs/components/Mdx/Code/index.js | 262 ---- docs/components/Mdx/Code/styles.js | 80 -- docs/components/Mdx/Dependencies/Item.js | 33 - docs/components/Mdx/Dependencies/index.js | 26 - docs/components/Mdx/Headings/index.js | 33 - docs/components/Mdx/Headings/styles.js | 18 - docs/components/Mdx/InlineCode.js | 9 - docs/components/Mdx/Pagination/index.js | 46 - docs/components/Mdx/Pagination/styles.js | 24 - docs/components/Mdx/Pre.js | 13 - docs/components/Mdx/Props.js | 136 --- docs/components/Mdx/Showcase/Item.js | 28 - docs/components/Mdx/Showcase/index.js | 65 - docs/components/Mdx/index.js | 48 - docs/components/Spacing.js | 37 - docs/components/ThemeConfiguration/index.js | 65 - docs/components/ThemeHelper.js | 77 -- docs/constants.js | 61 - docs/context/theme.js | 34 - docs/context/themeConfiguration.js | 21 - docs/getStaticProps.js | 109 -- docs/next.config.js | 11 - docs/package.json | 51 - docs/pages/404.js | 29 - docs/pages/_app.js | 17 - docs/pages/_document.js | 45 - docs/pages/blog.js | 131 -- docs/pages/components/accordion.mdx | 119 -- docs/pages/components/alert.mdx | 172 --- docs/pages/components/aspect-ratio.mdx | 86 -- docs/pages/components/avatar.mdx | 95 -- docs/pages/components/badge.mdx | 89 -- docs/pages/components/box.mdx | 48 - docs/pages/components/breadcrumb.mdx | 90 -- docs/pages/components/button-group.mdx | 58 - docs/pages/components/button.mdx | 167 --- docs/pages/components/card.mdx | 94 -- docs/pages/components/checkbox.mdx | 292 ----- docs/pages/components/date-picker.mdx | 180 --- docs/pages/components/date-time-picker.mdx | 135 --- docs/pages/components/drawer.mdx | 266 ---- docs/pages/components/dropdown-menu.mdx | 183 --- docs/pages/components/emoji-picker.mdx | 256 ---- docs/pages/components/emoji.mdx | 75 -- docs/pages/components/field.mdx | 119 -- docs/pages/components/file-drop.mdx | 247 ---- docs/pages/components/file-upload.mdx | 251 ---- docs/pages/components/flex.mdx | 54 - docs/pages/components/grid.mdx | 82 -- docs/pages/components/hint.mdx | 42 - docs/pages/components/hook-form.mdx | 74 -- docs/pages/components/icons-font.mdx | 140 --- docs/pages/components/icons.mdx | 143 --- docs/pages/components/input-text.mdx | 213 ---- docs/pages/components/label.mdx | 97 -- docs/pages/components/link.mdx | 161 --- docs/pages/components/loader.mdx | 45 - docs/pages/components/markdown-editor.mdx | 169 --- docs/pages/components/modal.mdx | 452 ------- docs/pages/components/pagination.mdx | 95 -- docs/pages/components/password-input.mdx | 68 -- docs/pages/components/picker.mdx | 120 -- docs/pages/components/popover.mdx | 156 --- docs/pages/components/radio-group.mdx | 137 --- docs/pages/components/radio-tab.mdx | 60 - docs/pages/components/search.mdx | 199 --- docs/pages/components/select.mdx | 397 ------ docs/pages/components/shape.mdx | 78 -- docs/pages/components/slider.mdx | 229 ---- docs/pages/components/stack.mdx | 64 - docs/pages/components/swiper.mdx | 237 ---- docs/pages/components/table.mdx | 142 --- docs/pages/components/tabs.mdx | 358 ------ docs/pages/components/tag.mdx | 142 --- docs/pages/components/text.mdx | 92 -- docs/pages/components/textarea.mdx | 66 - docs/pages/components/time-picker.mdx | 92 -- docs/pages/components/toast.mdx | 431 ------- docs/pages/components/toggle.mdx | 124 -- docs/pages/components/tooltip.mdx | 149 --- docs/pages/contributing.mdx | 5 - docs/pages/index.js | 156 --- docs/pages/installation.mdx | 134 --- docs/pages/theming/basics.mdx | 144 --- docs/pages/theming/customize.mdx | 179 --- docs/pages/upgrade.mdx | 399 ------ docs/pages/upgrades/v2.mdx | 81 -- docs/pages/upgrades/v3.mdx | 27 - docs/pages/upgrades/v4.mdx | 106 -- docs/pages/utilities/use-copy-text.mdx | 88 -- docs/public/favicon.png | Bin 792 -> 0 bytes docs/public/illustration-404-white.png | Bin 105750 -> 0 bytes docs/public/illustration-404.png | Bin 105739 -> 0 bytes docs/public/illustration.png | Bin 20306 -> 0 bytes docs/public/og-image.png | Bin 90812 -> 0 bytes docs/public/robots.txt | 4 - docs/utils.js | 27 - package.json | 17 +- .../Accordion/docs/examples/open-at-start.tsx | 1 + packages/Accordion/docs/examples/overview.tsx | 1 + packages/Accordion/docs/examples/usage.tsx | 1 + .../docs/examples/with-custom-icon.tsx | 1 + scripts/watch.js | 2 +- website/build-app/components/Mdx/Div.tsx | 3 +- .../build-app/components/Mdx/Playground.tsx | 24 +- website/build-app/examples.js | 1 + .../build-app/utils/examples-page-exporter.ts | 6 +- website/tsconfig.json | 28 +- yarn.lock | 1070 +---------------- 146 files changed, 121 insertions(+), 13904 deletions(-) delete mode 100644 docs/babel.config.js delete mode 100644 docs/components/App.js delete mode 100644 docs/components/Colors.js delete mode 100644 docs/components/ComponentsList/Link.js delete mode 100644 docs/components/ComponentsList/VersionSelector/index.js delete mode 100644 docs/components/ComponentsList/index.js delete mode 100644 docs/components/ComponentsList/items.js delete mode 100644 docs/components/ComponentsList/styles.js delete mode 100644 docs/components/Footer.js delete mode 100644 docs/components/GlobalStyle.js delete mode 100644 docs/components/Head.js delete mode 100644 docs/components/Header/NavBar/index.js delete mode 100644 docs/components/Header/NavBar/styles.js delete mode 100644 docs/components/Header/ThemeSelector.js delete mode 100644 docs/components/Header/index.js delete mode 100644 docs/components/Header/styles.js delete mode 100644 docs/components/Homepage/Components.js delete mode 100644 docs/components/Homepage/Expectations.js delete mode 100644 docs/components/Homepage/Section.js delete mode 100644 docs/components/Homepage/Stats.js delete mode 100644 docs/components/HookForm.js delete mode 100644 docs/components/IconsList/Item.js delete mode 100644 docs/components/IconsList/Item.styles.js delete mode 100644 docs/components/IconsList/icons.js delete mode 100644 docs/components/IconsList/index.js delete mode 100644 docs/components/Illustration404.js delete mode 100644 docs/components/Layouts/Docs/index.js delete mode 100644 docs/components/Layouts/Docs/styles.js delete mode 100644 docs/components/Layouts/index.js delete mode 100644 docs/components/Logo.js delete mode 100644 docs/components/LogoWttj.js delete mode 100644 docs/components/Mdx/Code/CopyButton.js delete mode 100644 docs/components/Mdx/Code/index.js delete mode 100644 docs/components/Mdx/Code/styles.js delete mode 100644 docs/components/Mdx/Dependencies/Item.js delete mode 100644 docs/components/Mdx/Dependencies/index.js delete mode 100644 docs/components/Mdx/Headings/index.js delete mode 100644 docs/components/Mdx/Headings/styles.js delete mode 100644 docs/components/Mdx/InlineCode.js delete mode 100644 docs/components/Mdx/Pagination/index.js delete mode 100644 docs/components/Mdx/Pagination/styles.js delete mode 100644 docs/components/Mdx/Pre.js delete mode 100644 docs/components/Mdx/Props.js delete mode 100644 docs/components/Mdx/Showcase/Item.js delete mode 100644 docs/components/Mdx/Showcase/index.js delete mode 100644 docs/components/Mdx/index.js delete mode 100644 docs/components/Spacing.js delete mode 100644 docs/components/ThemeConfiguration/index.js delete mode 100644 docs/components/ThemeHelper.js delete mode 100644 docs/constants.js delete mode 100644 docs/context/theme.js delete mode 100644 docs/context/themeConfiguration.js delete mode 100644 docs/getStaticProps.js delete mode 100644 docs/next.config.js delete mode 100644 docs/package.json delete mode 100644 docs/pages/404.js delete mode 100644 docs/pages/_app.js delete mode 100644 docs/pages/_document.js delete mode 100644 docs/pages/blog.js delete mode 100644 docs/pages/components/accordion.mdx delete mode 100644 docs/pages/components/alert.mdx delete mode 100644 docs/pages/components/aspect-ratio.mdx delete mode 100644 docs/pages/components/avatar.mdx delete mode 100644 docs/pages/components/badge.mdx delete mode 100644 docs/pages/components/box.mdx delete mode 100644 docs/pages/components/breadcrumb.mdx delete mode 100644 docs/pages/components/button-group.mdx delete mode 100644 docs/pages/components/button.mdx delete mode 100644 docs/pages/components/card.mdx delete mode 100644 docs/pages/components/checkbox.mdx delete mode 100644 docs/pages/components/date-picker.mdx delete mode 100644 docs/pages/components/date-time-picker.mdx delete mode 100644 docs/pages/components/drawer.mdx delete mode 100644 docs/pages/components/dropdown-menu.mdx delete mode 100644 docs/pages/components/emoji-picker.mdx delete mode 100644 docs/pages/components/emoji.mdx delete mode 100644 docs/pages/components/field.mdx delete mode 100644 docs/pages/components/file-drop.mdx delete mode 100644 docs/pages/components/file-upload.mdx delete mode 100644 docs/pages/components/flex.mdx delete mode 100644 docs/pages/components/grid.mdx delete mode 100644 docs/pages/components/hint.mdx delete mode 100644 docs/pages/components/hook-form.mdx delete mode 100644 docs/pages/components/icons-font.mdx delete mode 100644 docs/pages/components/icons.mdx delete mode 100644 docs/pages/components/input-text.mdx delete mode 100644 docs/pages/components/label.mdx delete mode 100644 docs/pages/components/link.mdx delete mode 100644 docs/pages/components/loader.mdx delete mode 100644 docs/pages/components/markdown-editor.mdx delete mode 100644 docs/pages/components/modal.mdx delete mode 100644 docs/pages/components/pagination.mdx delete mode 100644 docs/pages/components/password-input.mdx delete mode 100644 docs/pages/components/picker.mdx delete mode 100644 docs/pages/components/popover.mdx delete mode 100644 docs/pages/components/radio-group.mdx delete mode 100644 docs/pages/components/radio-tab.mdx delete mode 100644 docs/pages/components/search.mdx delete mode 100644 docs/pages/components/select.mdx delete mode 100644 docs/pages/components/shape.mdx delete mode 100644 docs/pages/components/slider.mdx delete mode 100644 docs/pages/components/stack.mdx delete mode 100644 docs/pages/components/swiper.mdx delete mode 100644 docs/pages/components/table.mdx delete mode 100644 docs/pages/components/tabs.mdx delete mode 100644 docs/pages/components/tag.mdx delete mode 100644 docs/pages/components/text.mdx delete mode 100644 docs/pages/components/textarea.mdx delete mode 100644 docs/pages/components/time-picker.mdx delete mode 100644 docs/pages/components/toast.mdx delete mode 100644 docs/pages/components/toggle.mdx delete mode 100644 docs/pages/components/tooltip.mdx delete mode 100644 docs/pages/contributing.mdx delete mode 100644 docs/pages/index.js delete mode 100644 docs/pages/installation.mdx delete mode 100644 docs/pages/theming/basics.mdx delete mode 100644 docs/pages/theming/customize.mdx delete mode 100644 docs/pages/upgrade.mdx delete mode 100644 docs/pages/upgrades/v2.mdx delete mode 100644 docs/pages/upgrades/v3.mdx delete mode 100644 docs/pages/upgrades/v4.mdx delete mode 100644 docs/pages/utilities/use-copy-text.mdx delete mode 100644 docs/public/favicon.png delete mode 100644 docs/public/illustration-404-white.png delete mode 100644 docs/public/illustration-404.png delete mode 100644 docs/public/illustration.png delete mode 100644 docs/public/og-image.png delete mode 100644 docs/public/robots.txt delete mode 100644 docs/utils.js diff --git a/.circleci/config.yml b/.circleci/config.yml index 005e3c8307..0b2168708a 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -114,21 +114,21 @@ jobs: - packages/IconFont/fonts # current version build (common to previews & prod) - docs_build: + website_build: <<: *defaults steps: - attach_workspace: at: ~/welcome-ui - restore_cache: key: << pipeline.parameters.cache_version >>-welcome-ui-{{ .Environment.CIRCLE_SHA1 }} - - run: yarn docs:build + - run: yarn website:build - persist_to_workspace: root: ~/welcome-ui paths: - website/out # current version deploy for previews - docs_deploy_preview: + website_deploy_preview: <<: *defaults steps: - attach_workspace: @@ -138,7 +138,7 @@ jobs: - run: node_modules/.bin/netlify deploy --dir=website/out --alias $CIRCLE_BRANCH # current version deploy for production - docs_deploy_prod: + website_deploy_prod: <<: *defaults steps: - attach_workspace: @@ -156,7 +156,7 @@ jobs: - run: node_modules/.bin/netlify deploy --dir=docs_production --prod # previous versions build & deploy for production - previous_docs_versions_build_deploy_prod: + previous_website_versions_build_deploy_prod: <<: *defaults steps: - attach_workspace: @@ -165,7 +165,7 @@ jobs: key: << pipeline.parameters.cache_version >>-welcome-ui-{{ .Environment.CIRCLE_SHA1 }} - run: name: build w/ prefix - command: VERSION=$CIRCLE_BRANCH yarn docs:build + command: VERSION=$CIRCLE_BRANCH yarn website:build - aws-s3/sync: from: website/out to: s3://welcome-ui/docs_production/$CIRCLE_BRANCH @@ -205,7 +205,6 @@ jobs: command: yarn lerna publish from-git --yes --no-verify-access --dist-tag next workflows: - version: 2 btd: jobs: - checkout: @@ -253,13 +252,13 @@ workflows: requires: - yarn_install - build - - docs_build: + - website_build: filters: tags: only: /.*/ requires: - build - - docs_deploy_prod: + - website_deploy_prod: context: - aws - netlify @@ -272,18 +271,18 @@ workflows: requires: - test - lint - - docs_build + - website_build - build_and_release_icon_font - - docs_deploy_preview: + - website_deploy_preview: context: - netlify - welcome-ui requires: - test - lint - - docs_build + - website_build - build_and_release_icon_font - - previous_docs_versions_build_deploy_prod: + - previous_website_versions_build_deploy_prod: context: - aws - netlify diff --git a/.eslintignore b/.eslintignore index e77fdaddab..25ebde8eae 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,4 +1,3 @@ **/node_modules/** **/dist/** packages/Panda/** -docs/** diff --git a/.gitignore b/.gitignore index 5920310bc0..708459d200 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,5 @@ .env dist/ -docs/out -docs/.next website/out website/.next .cache/ diff --git a/.npmignore b/.npmignore index 0f6f9ee4a5..604327b89c 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,4 @@ /* !/dist/*.js *.test.js -/docs +/website diff --git a/README.md b/README.md index 8bf1d960b7..41c3b2bea1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Welcome UI - - Welcome to the _Welcome UI library_ created by [Welcome to the jungle](https://www.welcometothejungle.com), a customizable design system with react • typescript • styled-components • styled-system and ariakit. Here you'll find all the core components you need to create a delightful webapp. diff --git a/docs/babel.config.js b/docs/babel.config.js deleted file mode 100644 index e52d572838..0000000000 --- a/docs/babel.config.js +++ /dev/null @@ -1,17 +0,0 @@ -module.exports = { - presets: ['next/babel'], - plugins: [ - [ - 'styled-components', - { - ssr: true, - topLevelImportPaths: [ - '@xstyled/styled-components', - '@xstyled/styled-components/no-tags', - '@xstyled/styled-components/native', - '@xstyled/styled-components/primitives', - ], - }, - ], - ], -} diff --git a/docs/components/App.js b/docs/components/App.js deleted file mode 100644 index 1de3ff5f94..0000000000 --- a/docs/components/App.js +++ /dev/null @@ -1,51 +0,0 @@ -import React, { useEffect, useState } from 'react' -import { createTheme, WuiProvider } from '@welcome-ui/core' -import { MDXProvider } from '@mdx-js/react' -import { welcomeTheme } from '@welcome-ui/themes.welcome' -import { darkTheme } from '@welcome-ui/themes.dark' -import { welcomeDarkTheme } from '@welcome-ui/themes.welcome-dark' -import { Notifications } from '@welcome-ui/toast' - -import { useThemeContext } from '../context/theme' - -import { Layouts } from './Layouts' -import { MDXComponents } from './Mdx' -import { Head } from './Head' -import { GlobalStyle } from './GlobalStyle' - -const coreTheme = createTheme() - -const getTheme = themeStorage => { - if (themeStorage === 'welcome') { - return welcomeTheme - } else if (themeStorage === 'dark') { - return darkTheme - } else if (themeStorage === 'welcomeDark') { - return welcomeDarkTheme - } else { - return coreTheme - } -} - -export function App({ component: Component, pageProps }) { - const themeStorage = useThemeContext() - const initialTheme = welcomeTheme - const [globalTheme, setGlobalTheme] = useState(initialTheme) - - useEffect(() => { - setGlobalTheme(getTheme(themeStorage)) - }, [themeStorage]) - - return ( - - - - - - - - - - - ) -} diff --git a/docs/components/Colors.js b/docs/components/Colors.js deleted file mode 100644 index 53a094c27b..0000000000 --- a/docs/components/Colors.js +++ /dev/null @@ -1,57 +0,0 @@ -import React from 'react' -import { withTheme } from '@xstyled/styled-components' -import { Card } from '@welcome-ui/card' -import { Box } from '@welcome-ui/box' -import { Grid } from '@welcome-ui/grid' -import { Text } from '@welcome-ui/text' - -const getColors = (name, theme) => { - return Object.keys(theme.colors) - .filter(color => color.startsWith(name)) - .reduce((colors, color) => { - colors[color] = theme.colors[color] - return colors - }, {}) -} - -function Wrapper({ name, theme, colorsObject }) { - const colors = colorsObject || getColors(name, theme) - const isLight = name === 'light' - const textColor = isLight && 'light-900' - - return ( - - - - {Object.entries(colors).map(([key, depth]) => ( - - - - - {key} - - - {depth} - - - - ))} - - - - ) -} - -export const Colors = withTheme(Wrapper) diff --git a/docs/components/ComponentsList/Link.js b/docs/components/ComponentsList/Link.js deleted file mode 100644 index b15de4e25f..0000000000 --- a/docs/components/ComponentsList/Link.js +++ /dev/null @@ -1,37 +0,0 @@ -import React, { cloneElement, useEffect, useRef } from 'react' -import NextLink from 'next/link' -import { useRouter } from 'next/router' - -export function Link({ children, href, ...props }) { - const router = useRouter() - const ref = useRef() - let isActive = false - - useEffect(() => { - if (isActive) { - const element = ref.current - - if (element) { - element.scrollIntoView({ - block: 'center', - }) - } - } - }, [isActive]) - - if (router.pathname === href) { - isActive = true - } - - const childrenCloned = cloneElement(children, { - 'aria-current': isActive ? 'page' : undefined, - ref, - ...children.props, - }) - - return ( - - {childrenCloned} - - ) -} diff --git a/docs/components/ComponentsList/VersionSelector/index.js b/docs/components/ComponentsList/VersionSelector/index.js deleted file mode 100644 index 69e2923e61..0000000000 --- a/docs/components/ComponentsList/VersionSelector/index.js +++ /dev/null @@ -1,29 +0,0 @@ -import { Select } from '@welcome-ui/select' -import React from 'react' - -import { version } from '../../../../lerna.json' - -const versions = [ - { value: 'v5', label: `${version}` }, - { value: 'v4', label: 'v4' }, - { value: 'v3', label: 'v3' }, -] - -export function VersionSelector() { - const handleChange = value => { - if (['v3', 'v4'].includes(value)) { - window.open(`http://welcome-ui.com/${value}`, '_self') - } - } - - return ( -