documentation search bar

[fiumals]

hello :)

I thought it would be useful to have a search bar in the documentation to search all articles at once for a word or phrase, so i've been working on one, it looks like this

Also replaced the "Return to Homepage" link with the MusE Sequencer logo and title similar to the homepage, when clicked it still does return to the homepage though

A few things:

• It relies on a search_index.json file in the same directory as the other html files, which contains the text contents for most of the html files in that same directory, this json file gets fetched when on search.html with javascript
• The search_index.json is generated via the python script in docs/util_scripts/generate_search_index.py, which currently needs to be ran manually when an article is modified
• i also tampered with some core css rules to fix some margins in the mobile design but generally everything looks almost the same i think

let me know if anything needs adjusting!

[terminator356]

Hi sorry for the delay. Busy few days.

Just a quick question:
How does all of this affect adding new content?
If I add new text, or a new heading, will I have to do anything more?
Should it 'just work'?

Thanks.

[fiumals]

Hey! No problem, I figured you must be busy with other stuff.

As of now anytime you edit text or add new entries to the sidebar, the search_index.json needs to be updated by running a python script i wrote in docs/util_scripts/generate_search_index.py (should be ran from inside /docs directory), but aside from that nothing else should be needed afaik.

When making changes you would also need to commit that updated search_index.json file to have up to date search results though. I think it might be possible to automate updating the search index with github actions but to be honest I don't know much about how to use them yet, If you prefer I could look into that though! It might be more convenient

[terminator356]

Sure that would be great.

If no success, some clear instructions on what to do after a modification would be good.
Not sure where they could reside. Top code folder README.wiki?
On the documentation site itself?
If I recall there is a section 'helping out', or something like that, which describes how to edit the content,
how to clone it, edit it, push etc.
That might be a great place to append these new instructions.

I'll wait a bit to see what you find.

[fiumals]

Hello! i looked into workflows today and made one that takes care of the search generation when you submit any changes, i also set it to commit the generated index to the repository so that when you pull the changes offline the search is up to date when running the site locally as well.

I tested it by modifying some files myself without manually generating the search_index, and it seems to work fine, the search gets updated on its own, no extra steps should be needed now when modifying the wiki. I did add a section in "Editing this Wiki", explaining how to generate the search_index manually, but normally you wouldn't need to do so.

I believe you would have to make sure that the build and deployment source in the repository settings is set to "github actions" instead of "deploy from a branch" before merging though

let me know if anything else! I'd be glad to help :)