Skip to content

fix(docs): overall improvements #3129

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 28 commits into from
Apr 17, 2019
Merged

fix(docs): overall improvements #3129

merged 28 commits into from
Apr 17, 2019

Conversation

jacobmllr95
Copy link
Member

Describe the PR

This PR makes some overall improvements to the 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)

@jacobmllr95 jacobmllr95 requested a review from tmorehouse April 17, 2019 15:33
@codecov
Copy link

codecov bot commented Apr 17, 2019 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #3129   +/-   ##
=======================================
  Coverage   99.14%   99.14%           
=======================================
  Files         212      212           
  Lines        3860     3860           
  Branches     1153     1153           
=======================================
  Hits         3827     3827           
  Misses         26       26           
  Partials        7        7

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 2ce1ca5...afe0e83. Read the comment docs.

tmorehouse
tmorehouse reviewed Apr 17, 2019
View reviewed changes
@tmorehouse
Copy link
Member

Looks like the Right TOC is not rendering content as HTML:

image

It is escaping the < and > symbols

@tmorehouse tmorehouse closed this Apr 17, 2019
@tmorehouse tmorehouse reopened this Apr 17, 2019
@tmorehouse
Copy link
Member

tmorehouse commented Apr 17, 2019 •
edited
Loading

And the TOC sidebar is no longer collapsing non-active sections (they are all expanded):

image

Which might be due to the custom styles no longer being applied to it

@tmorehouse
Copy link
Member

tmorehouse commented Apr 17, 2019 •
edited
Loading

Just noticed that scrollspy is not detecting the newer nested structure of the TOC section, keeping the H2 links active when the H3 links are also active.

Will check on what has changed in the structure.

Typically is looks for the following sibling structure:

  <ul>
    <li>...</li> <!-- h2 -->
    <li>...</li> <!-- h2 -->
    <li>...</li> <!-- h2 -->
    <ul> <!-- subsection of previous h2 -->
      <li>...</li> <!-- h3 -->
      <li>...</li> <!-- h3 -->
    </ul>
    <li>...</li> <!-- h2 -->
    <ul> <!-- subsection of previous <li> -->
      <li>...</li> <!-- h3 -->
      <li>...</li> <!-- h3 -->
    </ul>
</ul>

As nested <ul> should not be inside <li> elements for ScrollSpy supprted markup

@jacobmllr95
Copy link
Member Author

@tmorehouse The new structure is the one used by Bootstrap.

@tmorehouse
Copy link
Member

tmorehouse commented Apr 17, 2019 •
edited
Loading

But it doesn't follow their recommended structure for ScrollSpy navs (of which they are not using on the TOC because of their incorrect nested nav structure)

@tmorehouse
Copy link
Member

The LI with the nested UL is not receiving the 'active' class (although the nav-link inside the LI is)

@tmorehouse
Copy link
Member

Just checked ScrollSpy code at Bootstrap V4 repo, and they have the same issue with scrollspy not setting the active state on the nested UL's parent LI.nav-item element (although the a.nav-link does get the active state class)

jacobmllr95 and others added 3 commits April 17, 2019 23:54
@jacobmllr95
Update styles.scss
77527b8
@tmorehouse
Update toc.vue
0613d37 
Move font-weight bold class to the nav-link for top TOC heading link
@jacobmllr95
Update styles.scss
afe0e83
@jacobmllr95 jacobmllr95 requested a review from tmorehouse April 17, 2019 23:19
@jacobmllr95 jacobmllr95 merged commit be53376 into bootstrap-vue:dev Apr 17, 2019
@jacobmllr95 jacobmllr95 deleted the fix-docs-improvements branch April 17, 2019 23:25
@jacobmllr95 jacobmllr95 mentioned this pull request Apr 21, 2019
Merged
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmorehouse tmorehouse tmorehouse approved these changes

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

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