Documentation improvement

YaCy
1

Hi,
for a longer time I’ve been trying to improve the documentation, at least a little.

The docs are available as a github repository and anyone is welcome to improve them.

I created a list of all the docs available at the time at yacy.net, and @orbiter kindly added it to the homepage menu.

There is a link to FAQ, which is main manual now, links to three various “Operational” how-tos, and fragments of API description.

I also reordered the FAQ in some more logical way and added a few questions & answers.

Much of the information is still included in the legacy wiki and anyone, who could help with transfering the text from wiki to github, is warmly appreciated. Especialy the API description is just one page now, in contrast with many in the old wiki. Dump of wiki articles would help with converting to MarkDown.

Not sure, what is missing in the FAQ especially for newbies and what could help to improve the first experience with YaCy.

If you feel, you can add your experience, knowledge or tips&tricks, or you can help improving the docs even with few lines, please do so!

3 Likes
2

And if you want to start improving the documentation, and don’t know where to start, you can pick one of “Documentation” labeled Issues on GitHub. Or pick a wiki entry and transfer it to github.

3

Ranking rules imported from the old wiki into documentation.
Crawler API organised and formated.
Link to release.yacy.net added to Download section, since there wasn’t an official release for quite a long time and automaticaly built package is the newest one we have.

4

@orbiter, does wiki allow you to export individual articles as wiki markdown?
it would be easier to convert the articles to .md from raw wiki, than doing the formatting manually…
could you make a dump or somethig, please?

5

Yes good idea, I will try an export.

6

I made an export and had a look at the dump which was crazy big, 1.5GB.
It is full of strange things, obviously scripted log-in attempts and content that the wiki filtered out using some kind of spam filter by itself, I did not know that mediawiki can do that. I cannot provide the dump in that form, with the crap inside and without filtering out personal information. Please be patient while I work on clean this thing.