Skip to content

Commit

Permalink
Rename docs folder (#1869)
Browse files Browse the repository at this point in the history
* rename docs folder to guides

* update links to docs

* update storybook config for guides

* log changes

* include addon-actions

* correct the filename links

* fix contributing doc
  • Loading branch information
JohnC-80 authored Jul 18, 2022
1 parent 5fcea71 commit 5f57f1b
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .storybook/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module.exports = {
postcss: false, // we use our own postcss setup
},
stories: [{
directory: '../docs',
directory: '../guides',
titlePrefix: 'Guides',
files: '**/*.mdx'
},
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Before adding a new component, be sure that your use-case isn't already covered
Please limit PR's in scope. A PR with a high number of changed files can be quite difficult to effectively review. The last thing that we want is to merge in the fix to a single problem while introducing 4 or 5 new ones at the same time.

## Testing
Component tests are automated browser tests powered by karma and written using mocha syntax. See [Testing in Stripes Components](docs/Testing.md) for more information.
Component tests are automated browser tests powered by karma and written using mocha syntax. See [Testing in Stripes Components](guides/Testing.stories.mdx) for more information.
6 changes: 3 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ To see components in action, our storybook can be run locally via the command

1. Reach out to the core FOLIO team on Slack, or via a JIRA in the STCOM project at [issues.folio.org](https://issues.folio.org) We can make suggestions for alternative stripes-components or props that may need to be applied to achieve the necessary results.
2. If your use-case cannot be solved with the current state of a component, the path forward is to create a PR for the change on the stripes-components repo. The change should meet the following criteria:
1. Be mindful of accessibility in the rendered markup. Check out our [Accessibility guide](docs/Accessibility.md)
2. Have additional tests written and passing. See our [Testing guide](TESTING.md)
1. Be mindful of accessibility in the rendered markup. Check out our [Accessibility guide](guides/AccessibilityDevPrimer.stories.mdx)
2. Have additional tests written and passing. See our [Testing guide](guides/testing.stories.mdx)
3. Be documented for other developers:
* in the CHANGELOG.md
* in the component's README.md if it affects the component's API or is noteworthy to future users of the components.
4. Be in-line with [stripes-components style guidelines](docs/CSSinStripes.md)
4. Be in-line with [stripes-components style guidelines](guides/CSSinStripes.stories.mdx)


4. **There’s not a component that meets the use case I have. What should I do?**
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,14 @@ Component | doc | categories
There are also various [utility _functions_](util) (as opposed to React components), which are [documented separately](util/README.md).

## Accessibility
* [Accessibility overview](docs/AccessibilityOverview.md) - general overview of some utilities that stripes-components provides.
* [Accessibility for developers](docs/AccessibilityDevPrimer.md) - dev-specific primer for accessibility. More direct code/component reference - a great intro for those who are unfamiliar to accessibility.
* [Accessibility overview](guides/AccessibilityOverview.stories.mdx) - general overview of some utilities that stripes-components provides.
* [Accessibility for developers](guides/AccessibilityDevPrimer.stories.mdx) - dev-specific primer for accessibility. More direct code/component reference - a great intro for those who are unfamiliar to accessibility.

## Patterns
Useful recipes for UI patterns appearing in FOLIO modules.

* [Show/Hide Columns in MCL](docs/patterns/ColumnSelector.md) -- Give users the ability to select only the data they need to see.
* [Accessible Routing](docs/patterns/AccessibleRouting.md) -- Detail the approaches to implementing accessible focus management.
* [Show/Hide Columns in MCL](guides/patterns/ColumnSelector.stories.mdx) -- Give users the ability to select only the data they need to see.
* [Accessible Routing](guides/patterns/AccessibleRouting.stories.mdx) -- Detail the approaches to implementing accessible focus management.

## Testing
Stripes Components' tests are automated browser tests powered by
Expand All @@ -173,7 +173,7 @@ This will spin up Karma via
[`stripes-cli`](https://github.com/folio-org/stripes-cli) and run all
tests locally in the Chrome browser.

See our [testing documentation](docs/Testing.md) for more information
See our [testing documentation](guides/Testing.stroies.mdx) for more information
on writing tests.

## FAQ
Expand All @@ -192,8 +192,8 @@ and

Some related documents:

* [Guide to UI Module Layout Components](docs/UIModuleLayout.md)
* [CSS for stripes-components development](docs/CSSinStripes.md)
* [Guide to UI Module Layout Components](guides/UIModuleLayout.stories.mdx)
* [CSS for stripes-components development](guides/CSSinStripes.stories.mdx)
* [Change-log](CHANGELOG.md)

See project [STCOM](https://issues.folio.org/browse/STCOM) (STripes COMponents)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 5f57f1b

Please sign in to comment.