Initial draft of sample documentation

[sehqlr]

Hi there! This is my sample for Season of Docs.

I added the documentation to omw/templates/docs/search.html because the top of the page indicates that it should be the location of this documentation, but contained no other content.

I took two screenshots of the search results page and the concept page, added numbers, then created a section of documentation for each, and a table with a single entry at the bottom of the page. (I kept it short to speed up initial submission.)

If you'd like to request any edits to this sample, please feel free to comment here or email me.

Thanks for your time, Sam

[fcbond]

Hi,

this is a great start! It had no technical issues --- I am only not merging it as other people are also providing samples, and so want to leave some space.

Some suggestions to improve it:

• the screenshots are a bit fuzzy, can you use pdf instead of png?
• if you add e.g. sense results, then a table of contents would be good at the top.
• rather than add a table of semantic relations here, you should link to the official documentation at https://globalwordnet.github.io/gwadoc/ We should do some work on harmonizing the look (or possibly even embedding it in a page here)
• the database ID it actually the ILI ID (interlingual Index), which should have its own documentation
• for technical terms like 'synset' we should come up with a standard class and link them to the glossary: omw/doc/glossary

[fcbond]

Thank you very much for your contribution, but we ended up going with Rohitesh's version.