chore: new website documentation

.circleci/config.yml

@@ -113,39 +113,39 @@ 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:
-            - docs/out
+            - website/out
 
   # current version deploy for previews
-  docs_deploy_preview:
+  website_deploy_preview:
     <<: *defaults
     steps:
       - attach_workspace:
           at: ~/welcome-ui
       - restore_cache:
           key: << pipeline.parameters.cache_version >>-welcome-ui-{{ .Environment.CIRCLE_SHA1 }}
-      - run: node_modules/.bin/netlify deploy --dir=docs/out --alias $CIRCLE_BRANCH
+      - 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:
           at: ~/welcome-ui
       - restore_cache:
           key: << pipeline.parameters.cache_version >>-welcome-ui-{{ .Environment.CIRCLE_SHA1 }}
       - aws-s3/sync:
-          from: docs/out
+          from: website/out
           to: s3://welcome-ui/docs_production
           arguments: |
             --metadata GitCommit=$CIRCLE_SHA1
@@ -155,7 +155,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:
@@ -164,9 +164,9 @@ 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: docs/out
+          from: website/out
           to: s3://welcome-ui/docs_production/$CIRCLE_BRANCH
           arguments: |
             --metadata GitCommit=$CIRCLE_SHA1 --delete
@@ -204,7 +204,6 @@ jobs:
           command: yarn lerna publish from-git --yes --no-verify-access --dist-tag next
 
 workflows:
-  version: 2
   btd:
     jobs:
       - checkout:
@@ -252,13 +251,13 @@ workflows:
           requires:
             - yarn_install
             - build
-      - docs_build:
+      - website_build:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - docs_deploy_prod:
+      - website_deploy_prod:
           context:
             - aws
             - netlify
@@ -271,18 +270,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

.depcheckrc.json

@@ -1,5 +1,4 @@
 {
-  "ignores": [
-    "@testing-library/*"
-  ]
-}
+  "ignores": ["@testing-library/*"],
+  "ignorePatterns": ["docs/*"]
+}

.eslintrc.js

@@ -1,4 +1,3 @@
 module.exports = {
   extends: './node_modules/wttj-config/lib/eslint/eslintrc-typescript',
-  ignorePatterns: ['docs'],
 }

.gitignore

@@ -1,7 +1,7 @@
 .env
 dist/
-docs/out
-docs/.next
+website/out
+website/.next
 .cache/
 node_modules/
 .DS_Store

.npmignore

@@ -1,4 +1,4 @@
 /*
 !/dist/*.js
 *.test.js
-/docs
+/website

README.md

@@ -1,7 +1,5 @@
 # Welcome UI
 
-<img src="docs/public/illustration.png" width="300" />
-
 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.