PointCloudLibrary / PointCloudLibrary/pcl
[Documentation] Web documentation is broken
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 4.7k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 6
Description
Describe the bug
Some links from a documentation page that lead to other documentation pages do not work. Not sure if this is an isolated case or if that happens to many pages.
The current web-hosted documentation can be accessed via the github page.
Context
Checking headers from the documentation
Expected behavior
A working web-hosted documentation
Current Behavior
404 Error not found
To Reproduce
In this page click on #include <pcl/PointIndices.h> on the top of the page, it will lead you to a non-existing page.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the hosted documentation page structpcl_1_1_point_indices.html and reproduce the 404 from the #include <pcl/PointIndices.h> link. Inspect how the web documentation creates links to header documentation, then verify that links between documentation pages work without 404 errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100