Skip to content

chore(docs): improve page load time by pre-parsing README.md at build time #5290

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 119 commits into from
May 5, 2020

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented May 1, 2020

Describe the PR

Improves page load time by using a custom loader to pre-parse the README.md files into
the required bits (title+lead, body, and base table of contents)

Improves SSR rendering by including the TOC in the SSR output.

PR checklist

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

  • Bugfix (fixes a boo-boo in the code) - fix(...), requires a patch version update
  • Feature (adds a new feature to BootstrapVue) - feat(...), requires a minor version update
  • Enhancement (augments an existing feature) - feat(...), requires a minor version update
  • ARIA accessibility (fixes or improves ARIA accessibility) - fix(...), requires a patch or minor version update
  • Documentation update (improves documentation or typo fixes) - chore(docs), requires a patch version update
  • Other (please describe) perf

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

  • No
  • Yes (please describe since breaking changes require a minor version update)

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, chore(docs): fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages, and determines the next version type (patch or minor).

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

  • Includes documentation updates
  • Includes component package.json meta section updates (prop, slot and event changes/updates)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (required for new features and enhancements)
  • Existing test suites are passing
  • CodeCov for patch has met target (all changes/updates have been tested)
  • 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)

@vercel
Copy link

vercel bot commented May 1, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/bootstrap-vue/bootstrap-vue/ly7u41ji8
✅ Preview: https://bootstrap-vue-git-docs-speed.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

codesandbox-ci bot commented May 1, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 79d063d:

Sandbox Source
twilight-framework-3qftg Configuration

@codecov
Copy link

codecov bot commented May 1, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5290   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          280       280           
  Lines         8721      8721           
  Branches      2491      2491           
=========================================
  Hits          8721      8721           
Flag Coverage Δ
#unittests 100.00% <0.00%> (ø)

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 79d063d...79d063d. Read the comment docs.

@vercel vercel bot temporarily deployed to Preview May 1, 2020 21:35 Inactive
@vercel vercel bot temporarily deployed to Preview May 3, 2020 11:34 Inactive
@vercel vercel bot temporarily deployed to Preview May 3, 2020 11:49 Inactive
@tmorehouse tmorehouse merged commit 74af02e into dev May 5, 2020
@tmorehouse tmorehouse deleted the docs-speed branch May 5, 2020 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Patch Requires patch version bump Type: Docs Type: Perf
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants