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

Update docs #220

Merged
merged 3 commits into from
Apr 27, 2016
Merged

Update docs #220

merged 3 commits into from
Apr 27, 2016

Conversation

levithomason
Copy link
Member

@levithomason levithomason commented Apr 26, 2016

This PR is a breakout of #206. Several issues were addressed:

  1. Robust _meta util

    Used to define / identify our components in tests and docs.

  2. Show addons in the sidebar.

    These are Stardust components added to the SUI framework.

  3. Show related components

    The jsdoc @see tag now links to related components. Used to relate Dropdown -> Select in the coming PR merge.

  4. Fix the sidebar filtering.

    Sections are no longer shown if there is no matching search.


Blocked by

https://github.com/TechnologyAdvice/stardust/pull/221

@levithomason levithomason force-pushed the feature/update-docs branch 2 times, most recently from bdbfb95 to 6f9c1c1 Compare April 26, 2016 20:40
@@ -1,68 +1,104 @@
import _ from 'lodash'
import React, { Component, PropTypes } from 'react'
import SEMANTIC_TYPES from 'docs/app/utils/SemanticTypes'
import STARDUST_TYPES from 'docs/app/utils/StardustTypes'
Copy link
Member Author

Choose a reason for hiding this comment

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

cruft, these are not part of the _meta object and associated util.

_.includes(LIBRARY_VALUES, _.get(_meta, 'library')) &&
_.includes(TYPE_VALUES, _.get(_meta, 'type')) &&
_.includes(NAME_VALUES, _.get(_meta, 'name'))
)
Copy link
Member Author

Choose a reason for hiding this comment

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

We can now validate _meta objects. Meta is a static component prop, we need this below to identify / find the meta object from many possible sources.

* Extract the Stardust _meta object and optional key.
* Handles literal _meta objects, classes with _meta, objects with _meta
* @private
* @param {string|function|object} arg A class, a component instance, or meta object..
Copy link
Member

Choose a reason for hiding this comment

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

Should only be function | object, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Right you are, thanks.

@dvdzkwsk
Copy link
Member

Don't see anything that sticks out to me, looks good so far. 👻

@kyleturco
Copy link
Contributor

🐓 - looks like some great updates to the doc site

@levithomason levithomason merged commit 1e7121c into master Apr 27, 2016
@levithomason levithomason deleted the feature/update-docs branch April 27, 2016 17:07
@levithomason levithomason mentioned this pull request May 24, 2016
24 tasks
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.

3 participants