hound-search/hound

Add option for alternative link (docs, for example)

Ouverte

#212 ouverte le 4 juin 2016

 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (606 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (5 470 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Hound seems like it would be a great fit for my organization, but one feature which would be awesome to have would be the ability to link not just back to github/bitbucket/etc, but to generated docs or other resources derived from the source.

For example, when Hound links to this location:

https://github.com/ros/ros_comm/blob/kinetic-devel/clients/roscpp/include/ros/publisher.h

It could also provide links to the following locations:

http://docs.ros.org/api/roscpp/html/publisher_8h_source.html

http://docs.ros.org/api/roscpp/html/publisher_8h.html

And with a bit more contextual information, even this page:

http://docs.ros.org/api/roscpp/html/classros_1_1Publisher.html

Obviously these URLs would be pretty difficult to derive given no additional information, but I could easily have a Jenkins job generate some metadata for Hound, like a list of regexes for "if the file matches X, show URL Y as an alternate link".

This could also be done as a post-load thing using JavaScript, but it would be neat to have it as a native feature.

Guide contributeur