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.

Sign up for GitHub

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

Jump to bottom

docs(Example): add ShorthandExample and ability to version docs #1868

Merged
merged 9 commits into from
Sep 1, 2017
Merged

docs(Example): add ShorthandExample and ability to version docs #1868

merged 9 commits into from
Sep 1, 2017

Conversation

layershifter
Copy link
Member

@layershifter layershifter commented Jul 15, 2017 •
edited
Loading

This PR:

  • add ability for versioning the documentation with SUI version
  • add dedicated example component for shorthands

Versioning

_999 019

Shorthands

I think that each example should have full and shorthand markup and this code will be more clear for us:

<ComponentExample
  title='Icon Group'
  description='Groups can be formatted as icons.'
  examplePath='elements/Button/GroupVariations/ButtonExampleGroupIcon'
/>
<ShorthandExample examplePath='elements/Button/GroupVariations/ButtonExampleGroupIconShorthand' />

@codecov-io
Copy link

codecov-io commented Jul 15, 2017 •
edited
Loading

Codecov Report

Merging #1868 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1868   +/-   ##
=======================================
  Coverage   99.76%   99.76%           
=======================================
  Files         148      148           
  Lines        2556     2556           
=======================================
  Hits         2550     2550           
  Misses          6        6

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 e1ff28a...8c9e099. Read the comment docs.

@levithomason
Copy link
Member

levithomason commented Jul 16, 2017 •
edited
Loading

I was thinking of publishing multiple versions of the doc site itself. Something like lodash:

image

How do you envision we'd go about adding version tags to examples/components? One other idea is to use jsdoc tags. These would be parsed and added to docgenInfo.json by default with the current workflow.

I like the shorthand example idea. It would be great to figure a way to give us hints as to which components are missing shorthand examples.

Maybe to move this one forward you could update this PR with a couple examples and we can make a determination from there.

@layershifter
Copy link
Member Author

@levithomason I like your idea, I think that we will go with it. However, I still think that proposed idea with tags is good for SUI. I will make some updates.

@layershifter
Copy link
Member Author

Merge conflicts should be resolved

Alexander Fedyashov added 2 commits August 14, 2017 10:55
Merge branch 'master' of https://github.com/Semantic-Org/Semantic-UI-…
752f3fa 
…React into docs/example-n-version

# Conflicts:
#	docs/app/Components/ComponentDoc/ComponentExample.js
#	docs/app/Examples/collections/Menu/Types/index.js
#	docs/app/Examples/collections/Table/States/index.js
fix(ComponentExample): remove cruft divided
181c563
layershifter
layershifter commented Aug 14, 2017
View reviewed changes
Copy link
Member Author

@layershifter layershifter left a comment

Choose a reason for hiding this comment

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

Merge conflict resolved, ready for review

@layershifter
Copy link
Member Author

Has merge conflicts

Merge branch 'feat/breakpoint' of https://github.com/Semantic-Org/Sem…
7a04d09 
…antic-UI-React into feat/breakpoint

# Conflicts:
#	test/specs/addons/Breakpoint/Breakpoint-test.js
@layershifter
Copy link
Member Author

I solved merged conflicts, however I want merge #1981 before this, becuase there will be merge conflicts.

@levithomason
Copy link
Member

Unblocked, merged #1981

Alexander Fedyashov added 2 commits August 28, 2017 17:25
Merge branch 'master' of https://github.com/Semantic-Org/Semantic-UI-…
b6c3a10 
…React into docs/example-n-version

# Conflicts:
#	docs/app/Components/ComponentDoc/ComponentExample/ComponentExample.js
#	docs/app/index.ejs
mixed(ComponentExample): merge with master, update version position
8c9e099
@layershifter
Copy link
Member Author

@levithomason I've merged with master and updated initial message for clarification. Ready for review.

@levithomason
Copy link
Member

Looks good, thanks!

@levithomason levithomason merged commit 7f39631 into master Sep 1, 2017
@levithomason levithomason deleted the docs/example-n-version branch September 1, 2017 15:44
@levithomason
Copy link
Member

Released in [email protected]

layershifter added a commit that referenced this pull request Sep 11, 2017
@layershifter
docs(Example): add ShorthandExample and ability to version docs (#1868)
aa370c5 
* docs(Example): add ShorthandExample and ability to version docs

* docs(Example): add versions to examples

* docs(Example): use Shorthand example

* fix(ComponentExample): remove cruft `divided`

* mixed(ComponentExample): merge with master, update version position
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@layershifter @codecov-io @levithomason