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

Issue 259: Impliment Table of Contents #264

Merged
merged 7 commits into from Feb 9, 2019

Conversation

Projects
None yet
4 participants
@SamFritz
Copy link
Member

SamFritz commented Feb 8, 2019

This PR adds in a table of contents (toc) for each learning guide. This implementation is a result of feedback from a user survey.


**GitHub Issues: 259: AUK Documentation - Impliment ToC

What does this Pull Request do?

Work complete includes:

  • code formatting of a table of contents for each learning guide using anchors/links to each H3 section. (Thanks @ruebot for guidance on ruby routing!)
  • adds in a "back to top" anchor for each section within the guide to bring back to toc
  • updates css file so that toc follows same style and design as rest of site

How should this be tested?

Has been tested on safari and google chrome locally and renders without issue.

Additional Notes:

Please feel free to provide feedback on style and testing :)

Interested parties

@ruebot @ianmilligan1

Thanks in advance for your help with the Archives Unleashed Toolkit!

@SamFritz SamFritz self-assigned this Feb 8, 2019

@SamFritz SamFritz requested review from ruebot and ianmilligan1 Feb 8, 2019

@codecov-io

This comment has been minimized.

Copy link

codecov-io commented Feb 8, 2019

Codecov Report

Merging #264 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #264   +/-   ##
=======================================
  Coverage   96.39%   96.39%           
=======================================
  Files          35       35           
  Lines         555      555           
=======================================
  Hits          535      535           
  Misses         20       20

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 d7d3dbb...1ee5ff7. Read the comment docs.

@ruebot
Copy link
Member

ruebot left a comment

Some formatting and syntax fixes.

<li class="toc-li"><%=link_to('What Can We Learn From Sentiment Analysis?', anchor: '5toc') %></li>
</ul>
</div>
<br>

This comment has been minimized.

@ruebot

ruebot Feb 9, 2019

Member

All the <br>s in this PR need to be self-closing: <br />

@@ -268,6 +268,50 @@ body {
padding: 15px;
text-align:left;
}
/*
* AUK Derivative Pages - table of contents customization

This comment has been minimized.

@ruebot

ruebot Feb 9, 2019

Member

Add a period at the end.

margin-left: 20px;
margin-top: 5px;
margin-bottom: 5px;
}

This comment has been minimized.

@ruebot

ruebot Feb 9, 2019

Member

Line break after }.

line-height: 1.4;
margin-left: 20px;
margin-right: 25px;
}

This comment has been minimized.

@ruebot

ruebot Feb 9, 2019

Member

Line break after }.

@SamFritz

This comment has been minimized.

Copy link
Member

SamFritz commented Feb 9, 2019

Thanks for taking a look @ruebot! I’ll make implement those changes.

@ianmilligan1
Copy link
Member

ianmilligan1 left a comment

This looks great. Tested locally and all the headers and back to tops are working well. Great work @SamFritz!

@ruebot

ruebot approved these changes Feb 9, 2019

@ruebot ruebot merged commit 3a51eac into master Feb 9, 2019

3 checks passed

codecov/patch Coverage not affected when comparing d7d3dbb...1ee5ff7
Details
codecov/project 96.39% remains the same compared to d7d3dbb
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ruebot ruebot deleted the issue-259toc branch Feb 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment