llvm / llvm/llvm-project

libunwind documentation is not on the LLVM website

Open
#162,444 1 comment 0 reactions 0 assignees View on GitHub
documentation libunwind
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

When Googling "llvm libunwind documentation", the first result is https://bcain-llvm.readthedocs.io/projects/libunwind/en/latest/ which is not hosted by LLVM, and is out of date.

Libunwind does have 2 documentation pages (https://github.com/llvm/llvm-project/tree/main/libunwind/docs) but I cannot find them anywhere on the LLVM site.

Contributor guide

Open the contributing guide

Research direction

Start with the two files under libunwind/docs and inspect how LLVM publishes other component documentation on its official website. Determine the appropriate publication entry point and verify that the libunwind documentation is discoverable on llvm.org rather than only through the external Read the Docs site.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.