llvm / llvm/llvm-project

[clang-doc] The Mustache HTML output uses full file paths for links

Open
#160,389 4 comments 0 reactions 0 assignees View on GitHub
clang-doc
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

These full paths break web pages if they're opened anywhere but the build machine, because the links are wrong. These should all be relative file paths.

Current HTML:

```html
@nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3
```

Corrected:

```html
@nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3
```

CC: @evelez7 I'm guessing this is somehow generated from the json paths. Do you know where in the JSONGenerator or the Mustache bits where the links are generated?

Contributor guide

Open the contributing guide

Research direction

Start by tracing how the JSONGenerator and Mustache parts produce the HTML links; inspect the generated path values shown in the issue. Update the link generation so output uses relative paths rather than the build-machine prefix, then verify the generated HTML matches the corrected example.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.