Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(layout-modules): reorder documentation contents #816

Conversation

rebecca-m-l
Copy link
Contributor

@rebecca-m-l rebecca-m-l commented Nov 2, 2020

Proposed changes

Reorder contents of documentation to:

  1. Overview
  2. API
  3. Anatomy
  4. Variants/Interactions
  5. ...

@rebecca-m-l rebecca-m-l requested a review from a team as a code owner November 2, 2020 14:02
@SimonFinney SimonFinney changed the base branch from dev to modular-layouts-documentation November 2, 2020 14:05
@rebecca-m-l rebecca-m-l changed the base branch from modular-layouts-documentation to dev November 2, 2020 14:07
@rebecca-m-l rebecca-m-l changed the base branch from dev to modular-layouts-documentation November 2, 2020 14:07
@netlify
Copy link

netlify bot commented Nov 2, 2020

Deploy preview for ibm-security ready!

Built with commit bfb7155

https://deploy-preview-816--ibm-security.netlify.app

@rebecca-m-l rebecca-m-l removed the request for review from a team November 2, 2020 14:08
@SimonFinney SimonFinney changed the title Modular layouts/design documentation docs(layout-modules): reorder documentation contents Nov 2, 2020
Copy link
Contributor

@SimonFinney SimonFinney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 💯

@SimonFinney SimonFinney merged commit 22d23c5 into carbon-design-system:modular-layouts-documentation Nov 2, 2020
kodiakhq bot pushed a commit that referenced this pull request Dec 2, 2020
* feat(layout-modules): add draft structure

* feat(layout-modules): add draft structure

* chore: add experimental release configuration

* chore(release): 1.25.0-experimental.1 [skip ci]

# [1.25.0-experimental.1](v1.24.0...v1.25.0-experimental.1) (2020-05-27)

### Bug Fixes

* **header:** inherit height to accommodate breadcrumb shadow ([#554](#554)) ([0d0e048](0d0e048))

### Features

* **filter-panel:** allow for string counts ([#567](#567)) ([6a02cc0](6a02cc0))

* chore(button-cluster): add module

* chore(page-tab): add module

* chore(layout-module): add `TypeLayout`

* chore(layout-modules): add action and title bar

* chore(layout-modules): add ICA

* chore(layout-modules): add card

* chore(release): 1.26.0-experimental.1 [skip ci]

# [1.26.0-experimental.1](v1.25.0...v1.26.0-experimental.1) (2020-06-09)

### Features

* **step-indicator:** update internals ([#593](#593)) ([8f69816](8f69816))

* docs(layout): add layout examples

* docs(layout): add layout examples

* docs(layout): update description

* docs(layout): update description

* docs(layout): add `Shell` to examples

* fix(ica-module): fix spacing

* fix(ica-module): fix spacing

* chore(release): 1.27.0-experimental.1 [skip ci]

# [1.27.0-experimental.1](v1.26.0...v1.27.0-experimental.1) (2020-06-17)

### Bug Fixes

* **ica-module:** fix spacing ([832fdb1](832fdb1))
* **ica-module:** fix spacing ([380067f](380067f))
* **layout:** add fit-and-finish for examples ([e1fde51](e1fde51))

### Features

* **layout-modules:** add draft structure ([6eda4d1](6eda4d1))
* **layout-modules:** add draft structure ([3c117ba](3c117ba))

* docs(storybook): update documentation

* docs(storybook): update documentation

* docs(layouts): update navigation title

* feat(storybook): add `addon-docs` support

* chore: clean cache

* docs(storybook): upgrade Storybook

* chore(addon-docs): rewrite documentation

* chore(addon-docs): experiment with theme switching

* chore(modular-layouts): background and title revisions

* chore(layout-modules): add higher-order components

* docs(layout-modules): update documentation

* chore: merge `dev` into `modular-layouts-documentation`

* docs(type-layout): add basic documentation

* chore(description): add `Description` documentation

* docs(with-layout): test examples

* ci: update configuration

* ci: update configuration

* chore(layout-modules): restructure folders

* chore(layout-modules): restructure folders

* docs(action-bar): force open snippet

* docs(action-bar): force open snippet

* docs(button-cluster): update documentation format

* docs(button-cluster): update documentation

* chore(carbon): upgrade dependencies, clean up overrides

* chore: add missing offline dependencies

* chore(carbon): upgrade dependencies, clean up overrides

* docs(button-cluster): update documentation

* docs(layout-modules): update content

* docs(ica-module): add helpers

* feat(modular-layouts): update API

* chore(storybook): fix theme switcher for `Docs`

* docs(layout-modules): update Storybook, center stories

* docs(layouts): use `UIShell`

* chore(page-tab): update positioning

* chore(page-tab): update positioning

* feat(modular-layouts): add render props

* chore(layout-modules): rename components

* feat: add `TypeLayoutModule`

* docs(modular-layouts): fix links

* chore: merge `modular-layouts-documentation` into `modular-layouts-render-props`

* build(addon-docs): add components to `MDXProvider`

* build(addon-docs): add components to `MDXProvider`

* feat(modular-layouts): remove private API

* feat(modular-layouts): add `as` prop

* docs(type-layout): update documentation

* docs(type-layout): update examples

* chore(background): migrate to Storybook component

* build(storybook): remove `addon-options`

* build(storybook): standardise documentation configuration

* docs(storybook): use Plex

* docs(storybook): fix canvas ordering

* docs(storybook): add documentation style overrides

* refactor(layout-modules): update style variables

* feat(description-list): rename module

* feat(layout-modules): update spacing

* docs(modular-layouts): add design documentation

* chore: merge `modular-layouts-documentation` into `modular-layouts/design-documentation`

* docs(layout-modules): share examples and troubleshooting

* feat(layout-modules): finalise API

* docs(storybook): update unordered list styles

* docs(action-bar): add WIP documentation

* docs(layout-modules): update story naming

* docs(layout-modules): rename variations

* docs(layout-modules): rename variations

* docs(storybook): update variant stories

* docs(storybook): disable scrolling in `Docs` tab

* docs(storybook): disable scrolling in `Docs` tab

* docs(storybook): disable scrolling in `Docs` tab

* docs(layouts): remove `PageTabModule`

* chore: merge `dev` into `modular-layouts-documentation`

* docs(layout-modules): update example layouts

* docs(layout-modules): add updated design documentation

* docs(layout-modules): add updated design documentation

* docs(layout-modules): add `Source` to MDX provider

* docs(card-module): remove layout considerations

* docs(layout-modules): story code updates

* docs(layout-modules): update `CardModule` stories

* modular layouts doc updates (#816)

* docs(layout-module): format with Prettier

* chore: merge `modular-layouts-documentation` into `dev`

* chore: merge `dev` into `dev-modular-layouts-documentation`

* docs(layout-modules): update links and view mode delegation

* docs(layout-modules): fix code formatting

Co-authored-by: semantic-release-bot <[email protected]>
Co-authored-by: Rebecca <[email protected]>
Co-authored-by: rebecca-m-l <[email protected]>
SimonFinney pushed a commit that referenced this pull request Dec 3, 2020
# [1.36.0-prerelease.2](v1.36.0-prerelease.1...v1.36.0-prerelease.2) (2020-12-03)

### Features

* **layout-modules:** add `withBackground` higher-order component ([#851](#851)) ([79c0077](79c0077))
* **layout-modules:** add comprehensive documentation ([#837](#837)) ([cfad653](cfad653)), closes [#554](#554) [#567](#567) [#593](#593) [#816](#816)
SimonFinney pushed a commit that referenced this pull request Dec 3, 2020
# [1.36.0](v1.35.0...v1.36.0) (2020-12-03)

### Bug Fixes

* **summary-card:** prevent scrollbar on action text ([#827](#827)) ([438e278](438e278))
* update header and panel `z-index` values ([#835](#835)) ([dc4026e](dc4026e))

### Features

* **combo-button:** add prop spreading to primary action button ([#847](#847)) ([04a48a0](04a48a0))
* **layout-modules:** add `withBackground` higher-order component ([#851](#851)) ([79c0077](79c0077))
* **layout-modules:** add comprehensive documentation ([#837](#837)) ([cfad653](cfad653)), closes [#554](#554) [#567](#567) [#593](#593) [#816](#816)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants