Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Missing warning redirects #1262

Open
augustjk opened this issue Nov 8, 2023 · 1 comment
Open

[docs] Missing warning redirects #1262

augustjk opened this issue Nov 8, 2023 · 1 comment

Comments

@augustjk
Copy link
Member

augustjk commented Nov 8, 2023

Following warning kinds do not have redirects:

Either these should have the warning kind replaced with '' in the issueWarning() call if the message accompanying is sufficient, or we should put these on lit.dev.

Tangentially related, I wonder if we should just have a list of all warning kinds on the site, maybe https://lit.dev/docs/tools/development/#development-build-runtime-warnings, as opposed to the /msg/{kind} urls redirecting to middle of docs.
The list of warnings can have summary descriptions. Those that warrant deep dives can then link to the relevant doc.
It's an extra point of maintenance but gives us a place to talk about the reasoning behind these warnings without finding an appropriate place in the doc to include it. It would also allow us to be more liberal about adding a warning kind instead of just '' as we issue warning without needing to have long accompanying messages in the console.

@AndrewJakubowicz
Copy link
Contributor

AndrewJakubowicz commented Nov 8, 2023

I like the idea of adding a "Development Warnings Index" page with the list of warnings.

"The list of warnings can have summary descriptions. Those that warrant deep dives can then link to the relevant doc."

I like!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants