Skip to content
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

Adding arrow on left of headers in help page #1075 #1076

Merged
merged 4 commits into from
Jun 7, 2022

Conversation

sam-glendenning
Copy link
Contributor

Description

As the help page is by far the longest page, I've added an arrow next to each of the main headings in the help page which, when clicked, takes the user to the top of the page again so they don't have to scroll all the way back up. Due to the help page being constructed from pure HTML, I had to use a Unicode-style icon for the links. This also required some additional logic in the table of contents construction so the icon wouldn't appear in the header names.

I couldn't decide which side to have the arrow on so kept it on the left for now but this can be easily changed. Here's what they look like for reference:

Left:
left

Right:
right

Testing instructions

Go to /help and try it out!

  • Review code
  • Check Actions build
  • Review changes to test coverage

Agile board tracking

Closes #1075

@sam-glendenning sam-glendenning added the enhancement New feature or request label May 31, 2022
@codecov
Copy link

codecov bot commented May 31, 2022

Codecov Report

Merging #1076 (b975962) into develop (2608a1a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop    #1076   +/-   ##
========================================
  Coverage    97.94%   97.95%           
========================================
  Files           42       42           
  Lines         1560     1566    +6     
  Branches       418      419    +1     
========================================
+ Hits          1528     1534    +6     
  Misses          31       31           
  Partials         1        1           
Impacted Files Coverage Δ
src/helpPage/helpPage.component.tsx 100.00% <100.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 2608a1a...b975962. Read the comment docs.

@louise-davies louise-davies removed the request for review from LunaBarrett June 7, 2022 08:27
@louise-davies
Copy link
Member

@sam-glendenning Could you take a look at the new code I wrote?

Copy link
Contributor Author

@sam-glendenning sam-glendenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Merge it if you're happy (PR owners can't approve their own request, despite you effectively hijacking this and leaving one line blamed to me 😂)

@sam-glendenning
Copy link
Contributor Author

Actually never mind, I have admin privileges, I'm happy with it, you're happy with it, we don't need this back and forth for a tiny PR

@sam-glendenning sam-glendenning merged commit 6223ec1 into develop Jun 7, 2022
@sam-glendenning sam-glendenning deleted the feature/arrow-to-top-of-page-#1075 branch June 7, 2022 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help page - add arrow to go to the top of the page
2 participants