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

feat: Add "Back to top" links (to the TOC index) #5581

Closed
wants to merge 3 commits into from
Closed

feat: Add "Back to top" links (to the TOC index) #5581

wants to merge 3 commits into from

Conversation

BSA10
Copy link

@BSA10 BSA10 commented Sep 30, 2021

What does this PR do?

Improve repo

Why is this valuable (or not)?

I think this helps the reader to look around the Index very quickly.

Checklist:

Followup

  • Check the output of Travis-CI for linter errors!

@eshellman
Copy link
Collaborator

see #5092
Be sure to check the free-programming-books-lint output for linter errors. Alphabetical order and spacing are the most common problems.

@davorpa davorpa added the New Feature New feature / enhancement / translation... label Sep 30, 2021
@davorpa
Copy link
Member

davorpa commented Sep 30, 2021

Implements part of the proposal

for english and arabic languages

@davorpa davorpa requested review from davorpa and removed request for davorpa September 30, 2021 23:07
@BSA10
Copy link
Author

BSA10 commented Sep 30, 2021

Implements part of the proposal

for english and arabic languages

If it is fine i will add it to all the languages.

@davorpa
Copy link
Member

davorpa commented Sep 30, 2021

Implements part of the proposal

for english and arabic languages

Do you want me to complete and add it to all the languages ?

ℹ️ Some feedback

It looks really pretty although in some parts with few resources seems a bit dense.

image

I would wait to see what @SethFalco or @eshellman thinks about with the purpose of avoid do more work than necessary

@eshellman
Copy link
Collaborator

Thank you for giving us a demo of "back-to-index" links. It's really valuable to the discussion in #5092.
It's a really bad time to merge something like this, though, because it's guaranteed to create conflicts for every other PR, of which we have a lot because of Hacktoberfest.
The things I notice, thanks to this work are

  • significant overhead (and work for us) when new sections are created.
  • seems like a lot of clutter with links after ever section
  • each language will need localization

@BSA10
Copy link
Author

BSA10 commented Oct 1, 2021

Implements part of the proposal

for english and arabic languages

Do you want me to complete and add it to all the languages ?

ℹ️ Some feedback

It looks really pretty although in some parts with few resources seems a bit dense.

image

I would wait to see what @SethFalco or @eshellman thinks about with the purpose of avoid do more work than necessary

So I have to cover all the advanced listings and the new section ?

And yes the in few resource will be some dense i thought about it but should we do?

@BSA10
Copy link
Author

BSA10 commented Oct 1, 2021

Thank you for giving us a demo of "back-to-index" links. It's really valuable to the discussion in #5092. It's a really bad time to merge something like this, though, because it's guaranteed to create conflicts for every other PR, of which we have a lot because of Hacktoberfest. The things I notice, thanks to this work are

  • significant overhead (and work for us) when new sections are created.
  • seems like a lot of clutter with links after ever section
  • each language will need localization

so, we put this aside and we have to figure out best solution for this.
Is that what you refer to?

@BSA10 BSA10 closed this Oct 1, 2021
@BSA10 BSA10 deleted the back-to-index branch October 1, 2021 01:21
@BSA10 BSA10 restored the back-to-index branch October 1, 2021 01:21
@BSA10 BSA10 reopened this Oct 1, 2021
davorpa pushed a commit to davorpa/free-programming-books that referenced this pull request Oct 1, 2021
- Codecademy
- Khan Academy

(cherry picked from EbookFoundation#5581)

Co-authored-by: aayushi-kunwar13 <51057675+aayushi-kunwar13@users.noreply.github.com>
@davorpa davorpa added the conflicts Conflict(s) need to be resolved label Nov 5, 2021
@davorpa davorpa changed the title Add "Back to index" to the README feat: Add "Back to top" links (to the TOC index) Nov 5, 2021
@davorpa
Copy link
Member

davorpa commented Nov 5, 2021

I propose align crosslink to the right

@eshellman
Copy link
Collaborator

I think static "link to index" would be too hard to maintain. Maybe a javascript that works on the github pages version?
closing this for now. Very much appreciate the PR, though.

@eshellman eshellman closed this Nov 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conflicts Conflict(s) need to be resolved New Feature New feature / enhancement / translation...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants