Skip to content

[Aliki] Improve header links#1465

Merged
st0012 merged 2 commits intomasterfrom
remove-outdated-go-to-top-link
Nov 22, 2025
Merged

[Aliki] Improve header links#1465
st0012 merged 2 commits intomasterfrom
remove-outdated-go-to-top-link

Conversation

@st0012
Copy link
Copy Markdown
Member

@st0012 st0012 commented Nov 22, 2025

  1. Remove top links next to the headers. This is a bad way to provide go-to-top feature. If users want it, we should do it differently in Aliki.
  2. Make headers directly linkable, instead of using the pilcrow icon. This will make the code simpler and IMO more natural.

@matzbot
Copy link
Copy Markdown
Collaborator

matzbot commented Nov 22, 2025 •
edited
Loading

🚀 Preview deployment available at: https://a80aa8a2.rdoc-6cd.pages.dev (commit: f183f9b)

@st0012 st0012 changed the title Improve header links in Aliki [Aliki] Improve header links Nov 22, 2025
@st0012 st0012 force-pushed the remove-outdated-go-to-top-link branch from fb9f104 to 62101ed Compare November 22, 2025 17:19
@st0012 st0012 force-pushed the remove-outdated-go-to-top-link branch from 62101ed to f183f9b Compare November 22, 2025 18:57
tompng
tompng approved these changes Nov 22, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@tompng tompng left a comment

Choose a reason for hiding this comment

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

👍

@st0012 st0012 merged commit f48d9e3 into master Nov 22, 2025
62 checks passed
@st0012 st0012 deleted the remove-outdated-go-to-top-link branch November 22, 2025 21:17
@voxik voxik mentioned this pull request Dec 3, 2025
Closed
voxik added a commit to voxik/sinatra that referenced this pull request Dec 3, 2025
@voxik
Fix RDoc 6.16+ compatibility by relaxing the check
13f2631 
With RDco 6.16, the following test started to fail:

~~~
  1) Failure:
RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]:
Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
"\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n".

  2) Failure:
RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]:
Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
"\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n".
~~~

and it is caused by this change: ruby/rdoc#1465

The error happens due to over-prescriptive RDoc check, it seems. Looking
into history, it seems the intention was just to check if RDoc works.
However, the check later started to look too much into details of
rendering.

Therefore, relax the check to look only for know text and basic
formatting and leave the rest as RDoc implementation detail.

Fixes sinatra#2131
voxik added a commit to voxik/sinatra that referenced this pull request Dec 3, 2025
@voxik
Fix RDoc 6.16+ compatibility by relaxing the check
594a9fc 
With RDoc 6.16.0, the following test started to fail:

~~~
  1) Failure:
RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]:
Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
"\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n".

  2) Failure:
RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]:
Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
"\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n".
~~~

and it is caused by this change: ruby/rdoc#1465

The error happens due to over-prescriptive RDoc check, it seems. Looking
into history, it seems the intention was just to check if RDoc works.
However, the check later started to look too much into details of
rendering.

Therefore, relax the check to look only for know text and basic
formatting and leave the rest as RDoc implementation detail.

Fixes sinatra#2131
voxik added a commit to voxik/sinatra that referenced this pull request Dec 3, 2025
@voxik
Fix RDoc 6.16+ compatibility by relaxing the check
4919b3f 
With RDoc 6.16.0, the following test started to fail:

~~~
  1) Failure:
RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]:
Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
"\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n".

  2) Failure:
RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]:
Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
"\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n".

~~~

and it is caused by this change: ruby/rdoc#1465

The error happens due to over-prescriptive RDoc check, it seems. Looking
into history, it seems the intention was just to check if RDoc works.
However, the check later started to look too much into details of
rendering.

Therefore, relax the check to look only for know text and basic
formatting and leave the rest as RDoc implementation detail.

Fixes sinatra#2131
voxik added a commit to voxik/sinatra that referenced this pull request Dec 3, 2025
@voxik
Fix RDoc 6.16+ compatibility by relaxing the check
c4d92cc 
With RDoc 6.16.0, the following test started to fail:

~~~
  1) Failure:
RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]:
Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
#    valid: true
"\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n".

  2) Failure:
RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]:
Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
#    valid: true
"\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n".
~~~

and it is caused by this change: ruby/rdoc#1465

The error happens due to over-prescriptive RDoc check, it seems. Looking
into history, it seems the intention was just to check if RDoc works.
However, the check later started to look too much into details of
rendering.

Therefore, relax the check to look only for know text and basic
formatting and leave the rest as RDoc implementation detail.

Fixes sinatra#2131
@voxik voxik mentioned this pull request Dec 3, 2025
Closed
dentarg pushed a commit to dentarg/sinatra that referenced this pull request Dec 25, 2025
@voxik @dentarg
Fix RDoc 6.16+ compatibility by relaxing the check
c02f660 
With RDoc 6.16.0, the following test started to fail:

~~~
  1) Failure:
RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]:
Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
#    valid: true
"\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n".

  2) Failure:
RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]:
Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
#    valid: true
"\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n".
~~~

and it is caused by this change: ruby/rdoc#1465

The error happens due to over-prescriptive RDoc check, it seems. Looking
into history, it seems the intention was just to check if RDoc works.
However, the check later started to look too much into details of
rendering.

Therefore, relax the check to look only for know text and basic
formatting and leave the rest as RDoc implementation detail.

Fixes sinatra#2131
dentarg pushed a commit to sinatra/sinatra that referenced this pull request Dec 25, 2025
@voxik @dentarg
Fix RDoc 6.16+ compatibility by relaxing the check
8b1c326 
With RDoc 6.16.0, the following test started to fail:

~~~
  1) Failure:
RdocTest#test_renders_inline_rdoc_strings_0 [test/rdoc_test.rb:19]:
Expected /<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
#    valid: true
"\n<h1 id=\"label-Hiya\"><a href=\"#label-Hiya\">Hiya</a></h1>\n".

  2) Failure:
RdocTest#test_renders_rdoc_files_in_views_path_0 [test/rdoc_test.rb:25]:
Expected /<h1[^>]*>Hello From RDoc(<span><a href=\"#label-Hello\+From\+RDoc\">&para;<\/a> <a href=\"#(documentation|top)\">&uarr;<\/a><\/span>)?<\/h1>/ to match # encoding: ASCII-8BIT
#    valid: true
"\n<h1 id=\"label-Hello+From+RDoc\"><a href=\"#label-Hello+From+RDoc\">Hello From RDoc</a></h1>\n".
~~~

and it is caused by this change: ruby/rdoc#1465

The error happens due to over-prescriptive RDoc check, it seems. Looking
into history, it seems the intention was just to check if RDoc works.
However, the check later started to look too much into details of
rendering.

Therefore, relax the check to look only for know text and basic
formatting and leave the rest as RDoc implementation detail.

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

Reviewers

@tompng tompng tompng approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@st0012 @matzbot @tompng