Vision and strategy for this app

[jenweber]

This is a brainstorming/discussion ticket

Challenges of the current app

• Difficult to find all the deprecations that apply within a range
• Sidebar is too narrow - most deprecations are too long and flow to the next line
• Folder structure showing major versions is tricky. When we make mistakes, it's messy.
• not all ids are in the search
• It happens commonly that deprecation guides are missing
• It happens commonly that deprecations in the source code do not have links
• We don't have linting or testing or styling on our code blocks

Possible solutions

• Ingest deprecation guide content in other apps like the Upgrade app
• Add CI coverage that checks if a deprecation guide is missing, and if a source code link is missing
• Add ids to search (and QA)
• Read major versions from the metadata of a guide instead of manually creating folder structure
• create separate files for the before & after examples displayed for individual guide
• Create styling for the before & after to show them side by side.
• Promote and update the Update app
• Make sidebar wider Make the sidebar wider #1058

Goals

We know that we want to keep the deprecation guide source of truth as its own separate resource

We know that SEO matters a lot

We know that we want links found in source code to live forever