readthedocs / ext-theme

Read the Docs drop in replacement site templates
2 stars 2 forks source link

Pages: add documentation/user error pages #304

Closed agjohnson closed 2 months ago

agjohnson commented 8 months ago

From #295, I'm considering the doc/user error pages separate work to help isolate the work more. Relevant conversation here:


agjohnson commented 3 months ago

I'm running into a lot of complexity with the proxito errors that are making this work fairly complicated.

I believe I will be breaking this work up into a few chunks:

[^1]: We can't use icons. The hosted icon kit limits the kit usage by domain name, so custom domains and project sub domains aren't supported. [^2]: Our application JS interferes with addons JS, and some conflicts in custom elements exist already, like readthedocs-notification.

agjohnson commented 3 months ago

I'm leaning towards a very minimal error page, which might leave the door open to easier customization. But avoiding looking like the dashboard is my main need right now:

Image

humitos commented 3 months ago

A minimal page like the example looks great to me. I'd probably remove the paragraph that starts with "In the past..." from the section "The host nginx is unknown on Read the Docs" since that information is dated and I don't think there should be any project hitting that issue anymore.

Also, I think that "Admin" is now called "Settings" in the new dashboard.

agjohnson commented 3 months ago

Yeah, agreed! All of that copy needs to be updated and trimmed down. This content all provided by the contextual 404 templates (errros/404/) and I'll be tuning this next. If this content poses any problems, it's probably worth coming back to even as this content feels more like a liability than valuable. I think trimmed down they might be okay though.

The main part I'm working on right now is the structure and look/feel of these pages, but I'm also liking the direction here. I'll have a draft PR today probably.