contour-terminal / contour

Modern C++ Terminal Emulator
http://contour-terminal.org/
Apache License 2.0
2.4k stars 103 forks source link

Improve documentation on hyperlink decorations #1437

Closed christianparpart closed 8 months ago

christianparpart commented 8 months ago

we apparently miss that in the docs/website as well as the default contour.yml configuration file:

possible values are:

saliaku commented 8 months ago

can i help contribute ?

uspasojevic96 commented 8 months ago

@saliaku yes you can, there is sample config in https://github.com/contour-terminal/contour/blob/master/src/contour/contour.yml where you can update the comments for the decorations as well as https://github.com/contour-terminal/contour/blob/master/docs/configuration/profiles.md

christianparpart commented 8 months ago

@saliaku Many thanks for your interest. We really highly appreciate that. Also, you may want to join our Discord for some somewhat more realtime communication :)

saliaku commented 8 months ago

I am happy to contribute if only you could tell me exactly what to do , I currently use debian 12 on my laptop @uspasojevic96

Also @christianparpart I don't have discord maybe I can join in on signal, matrix or telegram

christianparpart commented 8 months ago

Have python around, so you can run the documentation website locally, then do this:

virtualenv .venv               # create a virtual env for python packages
source .venv/bin/activate      # see for alternative files extensions, depending on your shell)
mkdocs serve -a 127.0.0.1:8080 # will spawn a tiny website on localhost:8080

edit the files, which @uspasojevic96 mentioned (or any other documentation file) and then fire up your web browser and have it pointing to http://127.0.0.1:8080/ to prove-read.

You can deactivate the virtual python environment via deactivate and re-activate it whenever you resume working by rerunning the above source ... command again.

saliaku commented 8 months ago

virtual env up and runnig have made the necessary comments pls do check

christianparpart commented 8 months ago

Create a PR so we can :)

It is late night there now. I will check up later then :)

saliaku commented 8 months ago

I still havent got the hang of contributing , I would be awake for some more hours for sure

christianparpart commented 8 months ago

What time zone are you inz we can screen share help you via discord Tomorrow. I should be somewhat available during the day and late evening (UTC+1 here - Germany). P.s.: do not commit the .venv folder but only the changes you have made.

saliaku commented 8 months ago

I am in IST( +5:30 ) would be available after 12 noon IST Sorry for committing the .venv folder. will take care of that next time

saliaku commented 8 months ago

I will be free in 3 hours

christianparpart commented 8 months ago

I will be free in 3 hours

@saliaku, Join me in https://discord.gg/ncv4pG9 in channel #ASMR-coding :)

saliaku commented 8 months ago

is this issue closed ?

uspasojevic96 commented 8 months ago

it will auto close when merge happens