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

Hide unstable items from the API docs by default #2605

Merged
merged 3 commits into from
Aug 25, 2014
Merged

Hide unstable items from the API docs by default #2605

merged 3 commits into from
Aug 25, 2014

Conversation

tschaub
Copy link
Member

@tschaub tschaub commented Aug 22, 2014

This adds an "unstable" class to anything not marked with @api stable. By default, these items are hidden in the API documentation (people should be discouraged from using them). A checkbox allows for toggling the display of unstable items.

Default view:
stable

With "Stable Only" unchecked:
unstable

This should provide good motivation for making sure we have enough marked stable before the release.

This also removes the events from the sidebar.  These are repeated on the main page and only add unnecessary length to the sidebar.
@tschaub tschaub added this to the v3.0.0 milestone Aug 22, 2014
@elemoine
Copy link
Member

I like it! Please merge. Thanks.

tschaub added a commit that referenced this pull request Aug 25, 2014
Hide unstable items from the API docs by default.
@tschaub tschaub merged commit c899324 into openlayers:master Aug 25, 2014
@tschaub tschaub deleted the stable-doc branch August 25, 2014 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants