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

[WIP] New documentation site #1773

Closed
wants to merge 140 commits into from
Closed

[WIP] New documentation site #1773

wants to merge 140 commits into from

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Aug 30, 2017

Issue: -documentation system is limited and hard to maintain-

What I did

I build a new documentation site built with next.js

Goals

  • pages based on markdown & react
  • great multi-framework support ( progress by @ndelangen )
  • pages should be fully viewable in GitHub
  • great dev experience (HMR)
  • great user experience (rich design)
  • great accessibility
  • fast, first paint and TTI
  • automatic contributions ( progress by @ndelangen )
  • multiple versions support ( progress by @igor-dv )
  • deploy from CI to main URL when on master
  • deploy to branch-URL when on PR ( handled by netlify )
  • Place branch-URL on PR
  • prepare for multi-language support
  • provide a page with statistics on the repo & npm, maybe some nice graphs? ( why storybook )
  • embed a storybook example
  • list of community examples

How to test

It's on netlify

@ndelangen ndelangen changed the base branch from master to release/3.3 August 30, 2017 21:20
@Hypnosphi
Copy link
Member

Great work! As far as I remember, you’ve deployed this to some custom domain. Can you bring it in?

"next/babel",
["env", {
"targets": {
"chrome": 52
Copy link
Member

Choose a reason for hiding this comment

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

Isn't the docsite supposed to work in a wider range of browsers?

@Hypnosphi
Copy link
Member

Is there a chance that some of those components would be useful as part of @storybook/components?

@Hypnosphi
Copy link
Member

Using close colours for background and text leads to bad readabiity =(

screen shot 2017-08-31 at 03 01 53

@Hypnosphi
Copy link
Member

Are those lines really needed?
screen shot 2017-08-31 at 03 04 03
screen shot 2017-08-31 at 03 05 34

@codecov
Copy link

codecov bot commented Aug 31, 2017

Codecov Report

Merging #1773 into master will increase coverage by 56.75%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #1773       +/-   ##
==========================================
+ Coverage   35.74%   92.5%   +56.75%     
==========================================
  Files         472       6      -466     
  Lines       10134      40    -10094     
  Branches     1196       2     -1194     
==========================================
- Hits         3622      37     -3585     
+ Misses       5784       2     -5782     
+ Partials      728       1      -727
Impacted Files Coverage Δ
app/angular/bin/build.js
addons/storysource/src/loader/default-options.js
addons/storyshots/src/test-bodies.js
addons/knobs/src/vue/index.js
lib/ui/src/modules/shortcuts/index.js
addons/knobs/react.js
lib/components/src/navigation/routed_link.js
lib/core/src/client/preview/syncUrlWithStore.js
app/react/src/server/index.js
addons/storysource/src/preview.js
... and 452 more

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 d0d6e4f...f58a7a1. Read the comment docs.

@ndelangen ndelangen changed the base branch from release/3.3 to master December 23, 2017 23:04
# Conflicts:
#	.circleci/config.yml
#	addons/background/README.md
#	addons/info/README.md
#	addons/links/README.md
#	addons/notes/README.md
#	addons/storyshots/README.md
#	lib/components/src/index.js
#	package.json
#	yarn.lock
@Hypnosphi Hypnosphi added this to the v4.0.0 milestone Mar 8, 2018
@ndelangen ndelangen removed this from the v4.0.0 milestone May 24, 2018
@gabrielcsapo
Copy link
Contributor

@ndelangen is this going to be merged or are the changes stale?

@ndelangen
Copy link
Member Author

@gabrielcsapo thanks for the interest. @domyen is currently figuring out a improved design for this.

Likely a lot of this code is salvageable. It will need some upgrades for sure.

For not this is stale until we get the new design doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants