Jump to content
bfarber

Easier Documentation Search

IPS is constantly looking for ways to improve, and one area of focus is documentation. We get a lot of feedback regarding documentation, and quite frequently the feedback we receive is, unfortunately, too vague to act on specifically. It's always a pleasant delight to get specific, focused feedback on how we can improve.

Last week I happened across a topic on our forums with just this kind of feedback, and after reviewing the suggestion and what it would take to implement, we agreed that the work was worth it. Cap'n Refsmmat posted some well-thought-out, clear and concise feedback on a specific action we could take that would make finding documentation easier, and I'm happy to announce that this change has been put in place on our website.

It was pointed out that as a user, it doesn't matter too much where the documentation you are searching for is located specifically. Whether it is a community article, official documentation, or an error code - you just want to find out more information, regardless of where that information is located. Today I built a few Sphinx search indexes of our downloads area, our error codes database, our official documentation, and our community-submitted articles, and then built a search interface to query all of these areas at once. We have replaced the search form in our documentation area with this new search utility.

Feel free to test out the new search tool and let us know what you think! Just head on over to our documentation page and use the search box at the top of the page to look for whatever it is you need to find. We may evolve this new tool further in the future, but for now we hope that it helps you find what you are looking for with less hassle and bouncing around.


×
×
  • Create New...