apple / apple/pkl

Pkldoc generates broken page anchors

Open
#395 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
11.5k
Forks
402
Avg merge
1d 15h
Merged PRs (30d)
20

Description

Searching the standard library docs, I noticed that I always land at the top of the page, not at the function I search for. For example, searching for `sort` takes me to `https://pkl-lang.org/package-docs/pkl/current/base/Collection.html#sort()`. But `#sort()` doesn't exist, so I land at the top of the page. Inspecting the page source, I found that `id` attributes are erroneously percent-encoded:
```


```

Contributor guide

Open the contributing guide

Research direction

Reproduce the problem by opening the standard-library documentation URL for Collection.sort() and inspect the generated HTML around its anchor. Trace how pkldoc produces the percent-encoded id, then verify that the generated link resolves directly to the sort function instead of the top of the page.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.