Skip to content

Commit

Permalink
feat(storybook): documentation migration
Browse files Browse the repository at this point in the history
  • Loading branch information
castastrophe committed Oct 23, 2024
1 parent d8d2127 commit 3f0c466
Show file tree
Hide file tree
Showing 70 changed files with 89 additions and 6,687 deletions.
1 change: 0 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ NX_INTERACTIVE=true

# Default dev environment settings
NODE_ENV=development
STORYBOOK_URL="/preview/"
WATCH_MODE=true

# Optional NX settings
Expand Down
1 change: 0 additions & 1 deletion .eslintignore

This file was deleted.

2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ To kick-off the project's storybook locally, run:
yarn start
```

This is our development environment, where you can see all the components in action, and develop new components. All components must have a storybook entry. Edits to any of the `*.css`, `*.stories.js`, or `template.js` files in `components/*` will live reload in your browser. For more details about how to work within our Storybook setup, take a look at our [getting started Storybook guide](https://opensource.adobe.com/spectrum-css/preview/?path=/docs/guides-contributing--docs).
This is our development environment, where you can see all the components in action, and develop new components. All components must have a storybook entry. Edits to any of the `*.css`, `*.stories.js`, or `template.js` files in `components/*` will live reload in your browser. For more details about how to work within our Storybook setup, take a look at our [getting started Storybook guide](https://opensource.adobe.com/spectrum-css/?path=/docs/guides-contributing--docs).

This project is leveraging caching from [Nx](https://nx.dev/) to speed up the build process. If you are seeing unexpected results, you can clear the cache by running `yarn nx reset`.

Expand Down
10 changes: 1 addition & 9 deletions .github/workflows/publish-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,22 +75,14 @@ jobs:
run: yarn install --immutable

## --- BUILD --- ##
- name: Build docs site
- name: Build site
shell: bash
run: yarn build:site
env:
CHROMATIC_URL: ${{ inputs.storybook-url }}

- name: Build storybook site
if: ${{ ! inputs.storybook-url }}
shell: bash
run: yarn nx run storybook:build:docs

## --- DEPLOY WEBSITE TO NETLIFY --- ##
- name: Deploy
uses: nwtgck/actions-netlify@v3
with:
# publish-dir: site/dist
publish-dir: dist
production-branch: main
production-deploy: false
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
dist
dist-site
!tokens/dist/index.css
!tokens/dist/css/*.css
!tokens/dist/css/express/*.css
Expand Down
1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

# Static utility assets
tokens/custom-*/*.css
site/includes/*.js

# Compiled and generated files
dist
Expand Down
86 changes: 45 additions & 41 deletions README.md

Large diffs are not rendered by default.

Loading

0 comments on commit 3f0c466

Please sign in to comment.