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 live examples #3019

Merged
merged 6 commits into from
Feb 19, 2018
Merged

Docs live examples #3019

merged 6 commits into from
Feb 19, 2018

Conversation

igor-dv
Copy link
Member

@igor-dv igor-dv commented Feb 19, 2018

Issue: Add live examples to docs

What I did

image

  • Added examples to readme
  • Added examples to docs

@igor-dv igor-dv self-assigned this Feb 19, 2018
@codecov
Copy link

codecov bot commented Feb 19, 2018

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #3019      +/-   ##
=========================================
+ Coverage   37.28%   37.3%   +0.01%     
=========================================
  Files         435     435              
  Lines        9432    9427       -5     
  Branches      909     910       +1     
=========================================
  Hits         3517    3517              
+ Misses       5375    5336      -39     
- Partials      540     574      +34
Impacted Files Coverage Δ
addons/knobs/src/components/types/Date/index.js 23.52% <0%> (ø) ⬆️
addons/a11y/src/components/Report/RerunButton.js 0% <0%> (ø) ⬆️
addons/jest/src/components/Result.js 0% <0%> (ø) ⬆️
addons/jest/src/components/PanelTitle.js 0% <0%> (ø) ⬆️
addons/storysource/src/loader/inject-decorator.js 50.98% <0%> (ø) ⬆️
addons/actions/src/lib/types/symbol/index.js 81.25% <0%> (ø) ⬆️
lib/ui/src/modules/api/actions/api.js 51.85% <0%> (ø) ⬆️
addons/actions/src/lib/reviver.js 58.33% <0%> (ø) ⬆️
addons/info/src/components/PropVal.js 84.25% <0%> (ø) ⬆️
.../ui/components/stories_panel/stories_tree/index.js 38.73% <0%> (ø) ⬆️
... and 48 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 7844961...ad05bbc. Read the comment docs.

@igor-dv
Copy link
Member Author

igor-dv commented Feb 19, 2018

Have troubles to run docs on windows. Will investigate it later.

README.md Outdated
### 3.4.alpha
> Note, this is an Alpha version. Some of the features still might not be released

- [React Official](https://master--storybooks-official.netlify.com)
Copy link
Member

@Hypnosphi Hypnosphi Feb 19, 2018

Choose a reason for hiding this comment

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

Just https://storybooks-official.netlify.com

I'm also not sure about the "React Official" naming, would like to hear from @tmeasday and @ndelangen

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah. I feel some kind of conflict between showing the official storybook UI and showing the examples...

Copy link
Member

Choose a reason for hiding this comment

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

Yeah I wouldn't call it that. Don't we have a "React" example too? (cra-kitchen-sink).

official-storybook is like Storybook's storybook. Not quite sure how best to put that ;) Maybe it doesn't actually need to be on this page?

@igor-dv
Copy link
Member Author

igor-dv commented Feb 19, 2018

image

@igor-dv
Copy link
Member Author

igor-dv commented Feb 19, 2018

If nobody rejects the wording, feel free to merge 😉

@Hypnosphi Hypnosphi merged commit c8d4fbf into master Feb 19, 2018
@Hypnosphi Hypnosphi deleted the docs-live-examples branch February 19, 2018 21:57
@igor-dv
Copy link
Member Author

igor-dv commented Feb 20, 2018

@tmeasday,

Yeah I wouldn't call it that. Don't we have a "React" example too? (cra-kitchen-sink).

AFAIK, there is almost nothing valuable to user in cra-kitchen-sink (documentation-wise), all the examples are located now in the official.

official-storybook is like Storybook's storybook. Not quite sure how best to put that ;) Maybe it doesn't actually need to be on this page?

I would say, if we want to have a Storybook's storybook, we should put there only the stories of the actual UI. And separate all the other stuff to a different place. I am not sure regarding the naming though. (Official, Storybook's Storybook, StoryStoryBook 😬).

@Hypnosphi
Copy link
Member

Hypnosphi commented Feb 20, 2018

The reason why it's in the same place is that it's much more convenient for development.
@ndelangen also had a strong opinion on that AFAIR

@Hypnosphi Hypnosphi added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Feb 20, 2018
shilman pushed a commit that referenced this pull request Feb 21, 2018
@Hypnosphi Hypnosphi added patch:done Patch/release PRs already cherry-picked to main/release branch and removed patch:done Patch/release PRs already cherry-picked to main/release branch labels Mar 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants