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

fix: links to the available version of docs #1755

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Meng-Heng
Copy link
Collaborator

@Meng-Heng Meng-Heng commented Dec 16, 2024

Solving: keymanapp/keyman.com#415.

This PR is ready for review.

@Meng-Heng Meng-Heng added the fix label Dec 16, 2024
@Meng-Heng Meng-Heng added this to the A18S17 milestone Dec 16, 2024
Copy link
Contributor

@darcywong00 darcywong00 left a comment

Choose a reason for hiding this comment

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

Unsure how to handle anchored links

@@ -167,10 +167,9 @@ The presence of this store also ensures that Caps Lock is handled correctly for
KeymanWeb keyboards (see
[#5460](https://github.com/keymanapp/keyman/issues/5460#issuecomment-966602098)).

## Virtual character keys {#virtual-character-keys}
## Virtual character keys
Copy link
Contributor

Choose a reason for hiding this comment

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

We might need to update all the links to these anchors. This one corresponds to l.84

which might work if we change that to `(#toc-virtual-character-keys).

I'm not sure we want to change all the links this way though.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hello @darcywong00. The changes of this PR shows this:
image

Do you mean adding {#toc- in front of virtual-character-keys}, not removing them entirely? Also, may I know what is I.84? 😅

Copy link
Contributor

Choose a reason for hiding this comment

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

The abbreviation l.84 means "line 84" in the file (above).

keyboard, along with the specified modifier. [More info](#virtual-character-keys)

When I tried locally, clicking the "More info" links didn't work

I noticed the links in "On this page" did work though. And they had the toc- prefix...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you @darcywong00. I've seen the abbreviation once before but couldn't remember it.

Would this fix be appropriate? the {#virtual-character-keys} showed up like this if not removed.
image

I am trying {#virtual-character-keys} on "More info" but no success.
image

Only being scrolled to via clicking on "On this page", but the URL shows this:
http://help.keyman.com.localhost:8055/developer/language/guide/virtual-keys#toc-virtual-character-keys-virtual-character-keys-

I think #toc-virtual-character-keys was assigned as an id before converting to markdown.

@darcywong00 darcywong00 modified the milestones: A18S17, A18S18 Dec 21, 2024
@darcywong00 darcywong00 modified the milestones: A18S18, A18S19 Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants