[OPEN-ILS-DOCUMENTATION] Ideas for Docs Website

[Yamil Suarez]

On Nov 19, 2013, at 5:09 PM, Remington Steed <rjs7 at calvin.edu> wrote:

> Hi DIG,
>  
> I have been thinking about a few ideas that could improve the Docs website and make the Docs easier to use.  I would imagine both of these things being integrated into every page of the generated HTML docs, and I don’t know how difficult that would be.
>  
> 1.       It seems the Docs website needs a search box.  Could we try adding something like a Google custom search engine (https://www.google.com/cse/)?

Do you refer to the pages that host the HTML versions of the official docs, like these http://docs.evergreen-ils.org/2.5/ ? If so, I definitely agree, and this request definitely came up on an IRC meeting in the past. We would need to find a volunteer that would want to set the solution up.



> 2.       I think the Docs website needs an email link that lets readers easily provide feedback about missing sections or other problems.  Ideally, this link would be visible everywhere, so whenever someone is reading and finds a problem, the link is visible already.  But it would be fine to try it in a prominent place near the top, and also in the footer.
>  

My apologies, do you refer to the pages that host the HTML versions of the official docs and/or the pages for the DIG wiki pages? I would be for it appearing on both, though I can see confusion caused by seeing links to both report documentation bogs and to send feedback email. Though I think it would be worth it if properly labeled.

Thanks Remington!

Yamil