improve the docs for V5 launch #5820

ndelangen · 2019-03-02T17:28:48Z

Issue: docs are lagging behind implementation

What I did

Bringing the docs up to date

vercel · 2019-03-02T17:28:51Z

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

codecov · 2019-03-04T11:19:29Z

Codecov Report

Merging #5820 into next will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             next    #5820   +/-   ##
=======================================
  Coverage   34.91%   34.91%           
=======================================
  Files         648      648           
  Lines        9496     9496           
  Branches     1377     1377           
=======================================
  Hits         3316     3316           
  Misses       5563     5563           
  Partials      617      617

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2339ce7...a5ae822. Read the comment docs.

shilman

Changes look great!

shilman · 2019-03-07T09:14:31Z

docs/package.json

@@ -28,7 +28,7 @@
    "common-tags": "^1.8.0",
    "gatsby": "^1.9.279",
    "gatsby-link": "^1.6.45",
-    "gatsby-plugin-sharp": "^2.0.12",
+    "gatsby-plugin-sharp": "^1.6.48",


@ndelangen why downgrade?

I had some issues, I think the gatsby-plugin-sharp v2 is for gatsby v2

shilman · 2019-03-07T09:19:23Z

docs/src/pages/configurations/custom-webpack-config/index.md

+> We're trying to make storybook more zero-config over time, **help to hook into the config of generators is very welcome**.
+
+<details>
+  <summary>This is what the config for storybook looks like when using CRA in dev-mode:</summary>


Why do we put this in our docs? Can we just link to a file that won't get out of date every time somebody makes an change?

There is no single file that has this info, it's all merged from multiple presets.

I think it's valuable for people who want to customize to quickly see what we're shipping with to most users.

shilman · 2019-03-07T09:20:53Z

docs/src/pages/configurations/default-config/index.md

+
+  ```js
+  {
+    mode: 'development',


Duplicated??

yes, didn't know a good way of having a SSOT for this.

docs/src/pages/configurations/theming/index.md

shilman

See comments above

shilman · 2019-03-07T09:35:47Z

@ndelangen Outside the scope of this PR but we should publish the frontpage components as a standalone library and share them between both projects

# Conflicts: # docs/src/pages/basics/guide-mithril/index.md

…ing we publish

ndelangen · 2019-03-07T10:19:56Z

@ndelangen Outside the scope of this PR but we should publish the frontpage components as a standalone library and share them between both projects

I agree with the out of scope part

I'm not sure publishing these components as a library is worth our time. I mean maybe.

I think the docs should be more pure about 'content' and not about styling.
This PR is mainly to get it somewhat in sync visually, until we've integrated docs better into the build of the frontpage repo I think.

docs/src/new-components/layout/Header.js

ndelangen · 2019-03-08T13:14:46Z

@shilman Good to merge?

# Conflicts: # docs/src/pages/configurations/theming/index.md

ndelangen · 2019-03-08T23:13:32Z

@shilman can we please merge this, do you think?

shilman

LGTM! Great job 🚀

shilman · 2019-03-09T00:06:31Z

Adding redirects as documentation before I merge, although finally they will be applied to the frontpage directory not here

improve the docs for V5 launch

ndelangen added ci: do not merge documentation release labels Mar 2, 2019

ndelangen added this to the v5.0.0 milestone Mar 2, 2019

ndelangen self-assigned this Mar 2, 2019

ndelangen requested review from danielduan, Hypnosphi, shilman and usulpro as code owners March 2, 2019 17:28

ndelangen force-pushed the tech/improve-docs branch from d91c074 to fdc055f Compare March 2, 2019 20:33

vercel bot requested a deployment to staging March 2, 2019 20:33 Abandoned

ndelangen force-pushed the tech/improve-docs branch from fdc055f to 1e6650b Compare March 4, 2019 11:19

vercel bot requested a deployment to staging March 4, 2019 11:19 Abandoned

MOVE guides to /guides/ && update them with more concise information

9d7c28d

ndelangen force-pushed the tech/improve-docs branch from 1e6650b to 9d7c28d Compare March 4, 2019 12:18

vercel bot requested a deployment to staging March 4, 2019 12:18 Abandoned

IMPROVE webpack docs

91be9e8

vercel bot requested a deployment to staging March 4, 2019 13:00 Abandoned

IMPROVE default config docs

50a8670

vercel bot requested a deployment to staging March 4, 2019 13:06 Abandoned

ndelangen added 2 commits March 4, 2019 14:08

IMPROVE cli docs

d173ec5

IMPROVE theming docs

0dbf67c

vercel bot requested a deployment to staging March 4, 2019 13:31 Abandoned

IMPROVE docs for standalone

793c8ff

vercel bot requested a deployment to staging March 4, 2019 13:36 Abandoned

IMMPROVE the writing stories docs

dc9d97a

vercel bot requested a deployment to staging March 4, 2019 13:55 Abandoned

shilman approved these changes Mar 4, 2019

View reviewed changes

ndelangen changed the title ~~WIP: improve the docs for V5 launch~~ improve the docs for V5 launch Mar 6, 2019

ADD back port to official example

ab55972

shilman reviewed Mar 7, 2019

View reviewed changes

docs/src/pages/configurations/theming/index.md Outdated Show resolved Hide resolved

shilman reviewed Mar 7, 2019

View reviewed changes

docs/src/pages/configurations/theming/index.md Outdated Show resolved Hide resolved

shilman requested changes Mar 7, 2019

View reviewed changes

ndelangen added 3 commits March 7, 2019 11:08

Merge branch 'next' into tech/improve-docs

ee9b056

# Conflicts: # docs/src/pages/basics/guide-mithril/index.md

DELETE snyk, is just slowing down, and it's our docs site, not someth…

de6fffc

…ing we publish

FIX lockfile

a751468

shilman reviewed Mar 7, 2019

View reviewed changes

docs/src/new-components/layout/Header.js Outdated Show resolved Hide resolved

ndelangen added 3 commits March 7, 2019 12:10

Merge branch 'next' into tech/improve-docs

3445549

FIX logo not navigating

bc5f355

FIX incoreect semicolumns

7ea689c

Merge branch 'next' into tech/improve-docs

132daaf

# Conflicts: # docs/src/pages/configurations/theming/index.md

shilman approved these changes Mar 9, 2019

View reviewed changes

shilman added patch:yes Bugfix & documentation PR that need to be picked to main branch and removed release labels Mar 9, 2019

Document redirects

a5ae822

shilman merged commit 953c43b into next Mar 9, 2019

shilman deleted the tech/improve-docs branch March 9, 2019 00:30

shilman added a commit that referenced this pull request Mar 9, 2019

Merge pull request #5820 from storybooks/tech/improve-docs

435e4f0

improve the docs for V5 launch

shilman mentioned this pull request Mar 9, 2019

FOUC on storybook docs header #5981

Closed

shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve the docs for V5 launch #5820

improve the docs for V5 launch #5820

ndelangen commented Mar 2, 2019

vercel bot commented Mar 2, 2019

codecov bot commented Mar 4, 2019 •

edited

Loading

shilman left a comment •

edited

Loading

shilman Mar 7, 2019

ndelangen Mar 7, 2019

shilman Mar 7, 2019

ndelangen Mar 7, 2019

shilman Mar 7, 2019

ndelangen Mar 7, 2019

shilman left a comment

shilman commented Mar 7, 2019

ndelangen commented Mar 7, 2019

ndelangen commented Mar 8, 2019

ndelangen commented Mar 8, 2019

shilman left a comment

shilman commented Mar 9, 2019

improve the docs for V5 launch #5820

improve the docs for V5 launch #5820

Conversation

ndelangen commented Mar 2, 2019

What I did

vercel bot commented Mar 2, 2019

codecov bot commented Mar 4, 2019 • edited Loading

Codecov Report

shilman left a comment • edited Loading

Choose a reason for hiding this comment

shilman Mar 7, 2019

Choose a reason for hiding this comment

ndelangen Mar 7, 2019

Choose a reason for hiding this comment

shilman Mar 7, 2019

Choose a reason for hiding this comment

ndelangen Mar 7, 2019

Choose a reason for hiding this comment

shilman Mar 7, 2019

Choose a reason for hiding this comment

ndelangen Mar 7, 2019

Choose a reason for hiding this comment

shilman left a comment

Choose a reason for hiding this comment

shilman commented Mar 7, 2019

ndelangen commented Mar 7, 2019

ndelangen commented Mar 8, 2019

ndelangen commented Mar 8, 2019

shilman left a comment

Choose a reason for hiding this comment

shilman commented Mar 9, 2019

codecov bot commented Mar 4, 2019 •

edited

Loading

shilman left a comment •

edited

Loading