Skip to content

docs: minor tweaks #3621

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
Merged
merged 26 commits into from
Jul 5, 2019
Merged

docs: minor tweaks #3621

merged 26 commits into from
Jul 5, 2019

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jul 5, 2019 •
edited
Loading

Describe the PR

A few minor tweaks to docs

  • updated footer
  • add footer to /docs/* pages layout
  • style adjustments to TOC sidebar
  • minor style updates for playground
  • updates to tooltip/popover docs

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 5, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #3621   +/-   ##
=======================================
  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 90a29f0...6e7367f. Read the comment docs.

@codecov
Copy link

codecov bot commented Jul 5, 2019 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #3621   +/-   ##
=======================================
  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 a02ba33...396e234. Read the comment docs.

@tmorehouse tmorehouse requested a review from jacobmllr95 July 5, 2019 02:19
@jacobmllr95
Copy link
Member

jacobmllr95 commented Jul 5, 2019 •
edited
Loading

@tmorehouse Why don't we show the footer in the docs too?
The active state of the footer nav is also missing.

@tmorehouse
Copy link
Member Author

There were issues with the footer on the docs pages because of the sticky sidebars. but it would be nice to get it to appear on those pages too.

The active class isn't really needed on the links in the footer (as they don't have styles for active state (unlike the navbar at top).

@tmorehouse
Copy link
Member Author

@jackmu95 even bootstrap site doesn't use a footer on the docs pages: https://getbootstrap.com/docs/4.3/components/alerts/

@tmorehouse
Copy link
Member Author

We might be able to make a version of footer that fits between the sidebars and place it in the docs layout (or slugs for the docs pages)

@jacobmllr95 jacobmllr95 merged commit 2ff90c1 into dev Jul 5, 2019
@jacobmllr95 jacobmllr95 deleted the tmorehouse/tweaks branch July 5, 2019 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jacobmllr95 jacobmllr95 jacobmllr95 approved these changes

Assignees
No one assigned
Labels
Type: Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tmorehouse @jacobmllr95