search

projectEndings / staticSearch

A codebase to support a pure JSON search engine requiring no backend for any XHTML5 document collection
https://endings.uvic.ca/staticSearch/docs/index.html
Mozilla Public License 2.0
50 stars 22 forks source link

Reorganization of folder structure #295

Open martindholmes opened 5 months ago

martindholmes commented 5 months ago

@joeytakeda and I decided today that we should reorganize some content as follows:

  1. Create a resources folder in the root.
  2. Move the stemmers folder into it.
  3. Create a subfolder resources/lex, and put the English and French dictionary and stopwords files in there.

When files are moved, we should also add to the ODD file What's New in 2.0 section (which doesn't yet exist), and add to the v1-to-v2 conversion XSLT.

Ideas for further reorganization can be added to this ticket.

martindholmes commented 4 months ago

Quick question to @joeytakeda : We already have a What's New section in the documentation, and it has a section "Changes in version 2.0", which is where we should enumerate all the key changes. But the overall section is called "What's new since version 1.0", which I think we should retitle to just "What's new since version 1", and remove all the existing change records for versions in the 1.x line. The documentation for the 1.4 release branch does properly enumerate that set of changes, but I think for anyone moving from version 1 to 2, we should just document any differences between the last 1.4.x version and the new 2.0. What do you think?

joeytakeda commented 4 months ago

Hmm, I agree that we should retitle it, but I don't think we should remove the old change records (I think it could be useful especially if people are moving from an older version to a newer one or trying to debug something, plus I don't see much harm in keeping it)

What about doing what Saxon does and titling the section: "Change History". So something like: