Latex-workshop: Contribute to the wiki

[jlelong]

This is not a Bug Report but a call for contributions to the wiki, which will serve a detailed documentation for the extension, see #1007.

[tecosaur]

(Among other things) Thanks for reminding me about my earlier promise.

[tecosaur]

I've created a local copy of LaTeX-Workshop.wiki and made quite a few additions, however, I can't see any easy way for me to add them to the wiki. It seems one needs collaborator status or something in order to do so. Let me know if you're aware of an easier way, because I've got around 200 lines of new content which I'm keen to add :)

[jlelong]

@tecosaur you are right there is no straightforward way to make a PR on a github wiki.
I have just set up a new github repo containing the wiki content that can be forked. Then you can make PR and I will take care of the merge into the true wiki.
I have added a link at the bottom of every page to contribute.

[tecosaur]

Thanks :) Have done so.

[jlelong]

@James-Yu the wiki has grown up quite significantly. Event though some features are still missing, we can advertise it now. I think you could add a documentation entry in the _Resources_ section on the marketplace place.
What do you think of it?

[James-Yu]

It's great!

I am currently on vacation and will return to keyboard next week. Will do then.

[James-Yu]

Hmm I don't think there is a wiki entry in the resource section, nor did I find anything related in package.json. @jlelong any idea?

[jlelong]

I thought I had seen extensions with a documentation entry in the resources list but I cannot find it anymore. Ok, let's forget it. Anyway, I have added a link to the wiki at the beginning of the README.

[jlelong]

I have started a section on hovering features in the wiki. @tamuratak, could you help use with documenting hovering for maths and references?

[jlelong]

A few more calls for help

• [x] The section on formatting also needs some contribution...
• [x] More illustrations would really improve the documentation. Anyone ready to contribute some screenshots is welcome.
• [ ] More generally, we need help to double read the wiki and point out missing stuff.

[tamuratak]

@jlelong, sure. How do we add new screenshots?

[jlelong]

There are two approaches:

1. Upload the screenshots to LaTeX-Workshop/demo_media and refer to them using a full url link. As they are part of LaTeX-Workshop's repo, they can be used in the README.
2. Create a demo_file directory in wiki git and upload the screenshots there. Then, you can use relative links.

In both cases, you will have to use wiki git to add the links and associated explanations.
Hope this helps.

[jlelong]

@James-Yu, I have just come across what I was looking for concerning the _Resources_ section on marketplace. If you add a homepage entry in package.json, you will get a new item named _Homepage_ in the _Resources_ section.
See Cmake package.json and CMake Marketplace.

[jlelong]

Even though the wiki still needs to be updated, I am closing this issue.