assimp / assimp/assimp

Bug: Referenced documents, "ai_data" and "Post processing", missing

Open
#5,814 1 comment 0 reactions 0 assignees View on GitHub
Bug Doc
Dominant language
C++
Stars
13.2k
Forks
3.2k
Avg merge
2d 8h
Merged PRs (30d)
21

Description

**Describe the bug**
The document at https://assimp-docs.readthedocs.io/en/latest/usage/use_the_lib.html refers to documents that describe the imported data and available post processing steps. The doc. contains no links and a web search fails to find these documents.

There are other similar non-functional references.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to https://assimp-docs.readthedocs.io/en/latest/usage/use_the_lib.html
2. Scroll down to just below the box with the C++ example.
3. Observe this text:
"What exactly is read from the files and how you interpret it is described at the:ref:ai_data. The post-processing steps that the Assimp library can apply to the imported data are listed at #aiPostProcessSteps. See the @ref pp Post processing page for more details."
4. Notice that the references are not links.
5. Try to find the referenced docs in the table of contents or via a web search.
6. Fail.

**Expected behavior**
I expect the references to be links to the reference documents. I also expect to be able to find said docs with a web search.

**Screenshots**
n/a

**Platform (please complete the following information):**
- OS: macOS
- Browser Firefox
- Version [131.0]

**Additional context**
I need these documents to find out what to expected for the coordinate system and winding of the imported data and to see what post-processing may be available to convert to the desired coordinate system.

Contributor guide

Open the contributing guide

Research direction

Open the usage page at https://assimp-docs.readthedocs.io/en/latest/usage/use_the_lib.html and inspect the source behind its C++ example and surrounding references. Find the targets for ai_data, aiPostProcessSteps, and pp, then verify the links and related references resolve and the referenced documents appear in navigation or search.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.