Skip to content

docs: add some pizazz to index page #3613

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

Merged
merged 95 commits into from
Jul 4, 2019
Merged

docs: add some pizazz to index page #3613

merged 95 commits into from
Jul 4, 2019

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jul 3, 2019

Describe the PR

Adds a few cards to index page highlighting features, and minor adjustments for layout and style

Also reduces docs vendor bundles by importing only the highlight.js languages needed, and turning off eval-source-maps in prod mode (now enabled for dev mode only)

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

@codecov
Copy link

codecov bot commented Jul 3, 2019

Codecov Report

Merging #3613 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #3613   +/-   ##
=======================================
  Coverage   99.26%   99.26%           
=======================================
  Files         224      224           
  Lines        4333     4333           
  Branches     1234     1234           
=======================================
  Hits         4301     4301           
  Misses         26       26           
  Partials        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 9125e3b...6482f2d. Read the comment docs.

@jacobmllr95
Copy link
Member

@tmorehouse Yeah, exactly.

@tmorehouse
Copy link
Member Author

Just noticed that some of the docs site JS bundles are getting really huge... (i.e. > 6Mb)

Looks like some of the files are not being minified correctly by Nuxt (or our nut config)

@tmorehouse
Copy link
Member Author

Will figure out the docs asset sizes later.

@tmorehouse tmorehouse merged commit 90a29f0 into dev Jul 4, 2019
@tmorehouse tmorehouse deleted the tmorehouse/docs-splash branch July 4, 2019 20:55
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.

2 participants