Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a link to the web documentation in the command description #276

Open
mcarmonaa opened this issue Mar 5, 2019 · 1 comment
Open

Add a link to the web documentation in the command description #276

mcarmonaa opened this issue Mar 5, 2019 · 1 comment
Labels
empathy-sessions Issue filed as as part of empathy sessions

Comments

@mcarmonaa
Copy link

Related to the empathy session.

Command descriptions are really short, what is fine, but maybe a link to the web documentation in the main command description would be helpful.

@carlosms carlosms added the empathy-sessions Issue filed as as part of empathy sessions label Mar 5, 2019
@dpordomingo
Copy link
Contributor

I also think that linking web docs from command logs would be great... but then we could have broken links in the binary (what would be a bad idea)
If we do so, we should do integration tests to ensure that links in the command messages are up to date.
For a mature project, with stable docs and such, it's a great idea... but I think it won't for this evolving prod.

In the meanwhile, I'd vote for enhancing command descriptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
empathy-sessions Issue filed as as part of empathy sessions
Projects
None yet
Development

No branches or pull requests

3 participants