conan-io / conan-io/docs

[feature] Recipe attribute for library documentation url

Open
#2,545 3 comments 1 reaction 0 assignees View on GitHub
type: feature
Dominant language
C++
Stars
125
Forks
382
Avg merge
22h 39m
Merged PRs (30d)
21

Description

It would be nice to have an optional attribute for recipes to add a URL to the documentation of the library.

As `url` attribute points to the recipe origin repo (in the case of ConanCenter it is always `conan-center-index` repo) and `homepage` usually points to the library's repo or project web page, we are missing a direct link to the library documentation that could be:

- Specific page in the homepage of the project.
- Wiki section of library's repository.
- Specific folder inside library's repository (many libraries have their documentation next to the source code inside folders like `/docs` of `/examples`).
- ...

This would be nice information to have in order to get library code reference quickly via recipe inspection from Conan command line or from a future redesign of the ConanCenter webpage.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.