func-godot / func_godot_docs

Documentation for the FuncGodot plugin.
MIT License
4 stars 4 forks source link

Resolve lighthouse issues #7

Open RisingThumb opened 2 months ago

RisingThumb commented 2 months ago

Stemming from #6

You can run lighthouse yourself, by yourself using your browser dev tools. See this article that explains this: https://developer.chrome.com/docs/lighthouse/overview#devtools

I've attached a PDF of the current lighthouse report for the current site. Some of these are pretty simple like adding meta properties. Some are more complex like minifying CSS and minifying JS which would probably require a build step to do this. LighthouseIssues.pdf

RhapsodyInGeek commented 2 months ago

I'm not sure how any of this is really necessary? The docs load quickly enough that I don't see any human visible gains coming from the micro-optimizations listed, and the report doesn't even address actual user experience issues. SEO doesn't matter, since people looking for the docs will already know where they are if they downloaded the plugin.

Only thing that could be better would be accessibility, but that's something that could always be better.

The report doesn't give anything worthwhile actionable that isn't already known. I don't think we should worry about making the Google Lighthouse numbers go up for what amounts to simple user documentation. Instead let's just focus on actual experienced issues like #3 and #6.

RisingThumb commented 2 months ago

It's not so much about number going up = good, but more about addressing relevant points that lighthouse complains about that are worth addressing. It's not so much about accessibility either as just making sure obvious things haven't been missed out

Most of the other complaints look like noise to me, but I'm happy to be proven wrong in this EDIT: Looking through this and looking at the repo, I think the title and lang points are bogus... possibly caused by iframe weirdness, but not 100%. Feel free to correct me if I'm wrong here