There are links to CHM files in documentation
Open
Nobody has claimed this yet.
docs
priority-low
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
See: https://github.com/ni/nimi-python/pull/749#discussion_r169820152
The problem is that documentation in extracted metadata references the driver's CHM files. They should reference our own documentation in readthedocs or maybe the online documentation on ni.com. Or at the very least remove the link.
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 extracted metadata that produces documentation links and review the discussion in pull request 749 for the CHM-link context. Trace where those references are generated, then verify that the resulting documentation points to Read the Docs or ni.com, or contains no link to the driver CHM files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100