Add a `--edit` option

[BuonOmo]

Hey, I opened an issue to have a --edit option on tealdeer a while ago. See tealdeer-rs/tealdeer#286

I'm now using tlrc, do you think this could be a thing here ?

The idea behind this option is to make it easier for anyone to contribute to tldr-pages

[acuteenvy]

I guess printing the link to edit the page on GitHub would be fine. Opening a local editor would be pointless, since you have to clone the tldr repo in order to contribute, and the client only downloads a copy of the pages.

[waldyrious]

While I'm all for reducing participation barriers, in this case the clients would have to somehow integrate with GitHub to allow users to submit their changes as a PR, or even a mere issue. And what if the user doesn't have a GitHub account yet? I'm afraid making this a robust feature for clients to implement would add a lot of complexity both too the apps and to the spec.

Showing a link to edit the .md file, as @acuteenvy suggests, might be the most reliable middle ground we could reasonably ask of clients, but that feels rather small to justify an additional spec item, and even then it would not be optimal in that people might not see the contribution guidelines and project philosophy until after spending time working on their edits.

So while I definitely would love to see this feature implemented by a client, I don't think it's appropriate to make it part of the spec.

[BuonOmo]

So while I definitely would love to see this feature implemented by a client, I don't think it's appropriate to make it part of the spec.

Yes, I was not thinking about bubbling that up to the spec but rather make it client specific (at least until we know it works well and is used).

I guess printing the link to edit the page on GitHub would be fine. Opening a local editor would be pointless, since you have to clone the tldr repo in order to contribute, and the client only downloads a copy of the pages.

This would already be something, especially because GitHub has a neat workflow when you start editing a file in another repo, letting one fork along the way.

My original intention with however was a tiny bit different. I wanted it to be a way to edit and have the local change for me (like #136), and once I'm satisfied, then publish the change. That is also a workflow that exists in the well know brew command. So something like:

1. allow user to edit the command locally, and check if the result is satisfying.
   NOTE: for now, I use some ZSH script ->

   #!/usr/bin/env zsh
   
   local cache_path="$(tldr --info | awk '/Cache:/{print $2}')"
    
   mkdir -p "$cache_path/pages.custom/common"
    
   ${EDITOR-zed} "$cache_path/pages.custom/common/${(j:-:)@}.md"

2. have a workflow to check that this is complying to tldr-pages' contributing guidelines

3. Give the user a link to publish.
   Although this can for sure be a pain for someone not using GitHub to go through 1. and 2. and being blocked at the last step.

TBH, that is the workflow I've been using for myself for publishing pages, as I need to practice going back and forth between the command and its tldr page to make sure its content is useful.