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

Improve documentation on hyperlink decorations #1437

Closed
christianparpart opened this issue Jan 29, 2024 · 14 comments · Fixed by #1439
Closed

Improve documentation on hyperlink decorations #1437

christianparpart opened this issue Jan 29, 2024 · 14 comments · Fixed by #1439
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed website Website content or related

Comments

@christianparpart
Copy link
Member

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

possible values are:

  • underline
  • dotted-underline
  • double-underline
  • curly-underline
  • dashed-underline
  • overline
  • crossed-out
  • framed
  • encircle (i think that one is not realy implemented)
@christianparpart christianparpart added documentation Improvements or additions to documentation website Website content or related help wanted Extra attention is needed good first issue Good for newcomers labels Jan 29, 2024
@saliaku
Copy link
Contributor

saliaku commented Jan 29, 2024

can i help contribute ?

@uspasojevic96
Copy link
Member

uspasojevic96 commented Jan 29, 2024

@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
Copy link
Member Author

@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
Copy link
Contributor

saliaku commented Jan 29, 2024

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
Copy link
Member Author

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
Copy link
Contributor

saliaku commented Jan 29, 2024

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

saliaku added a commit to saliaku/contour that referenced this issue Jan 29, 2024
@christianparpart
Copy link
Member Author

Create a PR so we can :)

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

@saliaku
Copy link
Contributor

saliaku commented Jan 29, 2024

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

@christianparpart
Copy link
Member Author

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
Copy link
Contributor

saliaku commented Jan 29, 2024

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
Copy link
Contributor

saliaku commented Jan 30, 2024

I will be free in 3 hours

@christianparpart
Copy link
Member Author

christianparpart commented Jan 30, 2024

I will be free in 3 hours

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

saliaku added a commit to saliaku/contour that referenced this issue Jan 30, 2024
@saliaku
Copy link
Contributor

saliaku commented Jan 30, 2024

is this issue closed ?

@uspasojevic96
Copy link
Member

it will auto close when merge happens

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed website Website content or related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants