Raku / doc-website

Tooling to build/run the documentation website
Artistic License 2.0
7 stars 10 forks source link

Error page #25

Open finanalyst opened 1 year ago

finanalyst commented 1 year ago

a) there is an Errors page in the 'more' drop down on the navigation bar

This is an addition of mine to the work I did when developing Collection. I thought it would be useful in general.

Should I leave it in?

b) Other test results could be added to the errors page. Any suggestions?

c) There is a problem with the test as some valid links seem - I think - to be triggered. This may be due to the work to add extra functionality, so I need to look at it.

coke commented 1 year ago

My preference is to leave this only in debug builds and remove it from the prod site.

finanalyst commented 1 year ago

removing this issue. Link-Error-Test plugin is broken and needs work. This is not urgent

finanalyst commented 1 year ago

Reopening this issue. Link-error-test plugin partially repaired. Still has problems.

This is related to the issue for testing for bad links

Error report has been attached to more->anomalous links. It is picking up some 404 on remote sites, and a domain not recognised.

Some local errors are being incorrectly flagged as internal errors.

Quite a few missing files, so not all secondaries are being generated.

coke commented 1 year ago

There are a LOT of colors on this error page, and I find this jarring. My naïve suggestion is to replace the colored nested lists with headers per page and a table of issues on that page (or perhaps a single table where page is the first column).

coke commented 1 year ago

That said, any style changes can happen later, and I'm OK with closing this as completed and opening separate tickets for the remote link section, and for the UI if others agree.

finanalyst commented 1 year ago

I'm happy for the colours and UX to change in any way. The styling is all in Website/plugins/link-error-test/ so its just a SCSS change.

finanalyst commented 1 year ago

There are many link errors. However, I think the majority are now content errors. a) I have looked carefully at the ID generation in Pod::To::HTML when X<> markup is used. index-entries seem to be a major source of problems. b) Some X<> markup has been removed from pod6 sources since the official docs were last generated. This may have been related to the issue where links were causing the title to be above the window. Eg a callsame reference in 101-basics refers to functions#index-entry-dispatch-callsame. The anchor in the html on docs.raku.org should have been generated by an X<> mark up. That markup has been removed in Language/101-basics.pod6

I need some help removing the errors in the content files.

coke commented 1 year ago

We should disable the error page for the initial go live, but it's not urgent. Any other issues can be handled post go-live.

finanalyst commented 1 year ago

disabled for Go-Live. But it should be available for developer views, when we get those

finanalyst commented 1 year ago

@coke I have been looking at the index-entry failures. They are soft failures because the web page is opened, but the correct place on the page is not found.

I need a discussion with someone to go forward on this. There are several possibilities

Alternatively, the Rakudoc sources could be edited.

I'm loosing the plot a bit.

finanalyst commented 11 months ago

@coke @2colours @cfa I think finally I have a handle on all the index-entry- links.

These changes needed work on Raku::Pod::Render. I haven't uploaded the new version of RPR to fez. I have all the tests working now, but I want to do some more checks.