GitHub search no longer works and shouldn't be enabled by default

[Gooseus]

Apologies for my tone, but this issue triggered one of increasingly frequent mental breakdowns over the state of modern UX.

While interacting with your a site built on your framework, I tried to do a search for relateTo on this page - https://themetalfleece.github.io/neogma/docs/Models/Creating-Nodes-and-Relationships

The term exists ON THE PAGE in multiple places, but instead of letting me find those instances, it pops a modal to search the docs... and DOESN'T RETURN ANY RESULTS.

See screenshots below

relateTo appearing on page in 3 places:

CMD+F Search for relateTo showing "No Results!"

If you are going to replace the default Browser shortcut functionality (which you really shouldn't), then at least make sure it isn't being replaced by something breaking a fundamental feature... especially one that people specifically use to search code docs!

Thank you, I know development is hard, especially larger framework/platform projects, so apologies once again.... but still, pls fix, I see there is another issue referencing this functionality and I think their solution is good assuming you had a notice in the modal about it - https://github.com/CONNECT-platform/codedoc/issues/116

[loreanvictor]

no worries! the issue is not on-page search in this case though. the on-page search basically emulates what browser's own search would do, so it would find the keywords. the issue is the search functionality of the default search plugin in codedoc uses github's APIs to find in which pages the keyword appears, and that API apparently has changed behaviour as it is no longer working. I would need to figure out how to replace that and issue an update, or disable the search functionality that is enabled by default.

[loreanvictor]

p.s. I'd also appreciate PRs on this issue, since I am quite overwhelmed with work stuff atm and this might take a while. perhaps looking at this provides some context on how the search functionality works, and this is where the issue resides.

[loreanvictor]

update: apparently github no longer provides the code search API without authentication, which makes it useless for case of codedoc. I think the only solution is simply not to enable the github search plugin, and for that you'd need to contact the repository owner to change their codedoc config and remove the github search feature. this is typically found in .codedoc/content/index.tsx (example), looking like this:

            <ToC search={
                  config.misc?.github ? 
                  <GithubSearch$
                    repo="codedoc-docs" 
                    user={config.misc.github.user}
                    root={config.src.base}
                    pick={config.src.pick.source}
                    drop={config.src.drop.source}
                  /> : false
            }>{toc}</ToC>

which should be replaced by this (assuming the docs still need toc):

<ToC>{toc}</ToC>

[loreanvictor]

although the fix is for codedoc users to reconfigure their docs, I'll keep this issue open for changing the default setup (where github search is enabled by default in the configuration the CLI automatically props up).