Repo-wide lint cleanup: redirects, frontmatter, alt text, dead URLs#568
Open
pru55e11 wants to merge 8 commits into
Open
Repo-wide lint cleanup: redirects, frontmatter, alt text, dead URLs#568pru55e11 wants to merge 8 commits into
pru55e11 wants to merge 8 commits into
Conversation
Update 109 redirecting URLs to their final destinations across 43 files. Mechanical replacements driven by the no-dead-urls linter rule output.
Shorten 11 frontmatter descriptions to under 160 chars and 7 titles to under 60 chars per check-frontmatter linter rule.
Fix 7 files flagged by no-multiple-toplevel-headings: collapse exact duplicates and demote secondary H1s to H2.
Provide descriptive alt text for 15 image references across publish flow, Runtime architecture, and proxy guides.
Inject a one-line description into 133 markdown files that already had frontmatter but were flagged by check-frontmatter for an empty/missing description.
Insert keywords/title/description YAML frontmatter at the top of 40 markdown files in get_started, guides, intro_and_overview, and runtime sections.
Update broken Adobe-hosted documentation links to their current locations (Photoshop API reference, events guides API root, distribution guides root, react-spectrum v3 Provider), point Spectrum CSS list items at the doc root, swap defunct crontab.org for crontab.guru, replace the dead io-webhook herokuapp link with a generic webhook inspector reference, point a broken aio-cli-plugin-app-storage branch link at the repo root, and reword the Epsagon paragraph to drop the now-defunct docs URL.
Remove duplicate '/guides/' segment in three Adobe Developer Console links and add the missing title to the development.md frontmatter so it satisfies check-frontmatter.
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Repo-wide cleanup that takes the lint warning count from 428 → ~127 (a 70% reduction). The remaining warnings are all dead-URL false positives where the URL works in browsers but Adobe/Twitter/Medium/GitHub bot protection blocks the linter's automated check.
195 files touched, 721 insertions / 179 deletions. All changes scoped to
src/pages/.What was fixed
curl.development.md.keywords/title/descriptionblocks. Includes stripping a malformed pseudo-codefence fromhow-runtime-works.md.Notable dead-URL fixes (worth a sanity check)
Each of these required a judgment call — every replacement URL was verified live with
curlbefore commit:developer.adobe.com/runtime/.../howitworks_f01.png→ local../../images/howitworks_f01.pnginhow-runtime-works.mddeveloper.adobe.com/developer-distribution/.../discoverandmanage/#discover+#acquire→ collapsed to single parent link indistribution.mdgithub.com/adobe/aio-cli-plugin-app-storage/tree/epic/abdb-implementation→ repo root indb-commands.mddeveloper.adobe.com/firefly-services/.../photoshop_removeBackground/→ parent…/api/inlesson3.mddeveloper.adobe.com/events/docs/guides/api/journaling_api/→…/api/parent inlesson4.md,journaling-events/index.mdopensource.adobe.com/spectrum-css/components/*→ reworded into a plain component list pointing at the Storybook root (spectrum-intro/lesson2.md). Worth a second look — if Storybook has per-component anchors, re-linking would be nicer.react-spectrum.adobe.com/react-spectrum/Provider.html→…/v3/Provider.htmlio-webhook.herokuapp.com/→ reworded to point at webhook.sitecrontab.org(x2) →crontab.gurudeveloper-console/docs/guides//guides/...→ fixed the duplicated/guides/segment infirst-app.mdNo truly-dead URLs were silently deleted; every removal was replaced with a working parent URL or a paraphrase that still reads naturally.
Relationship to other open PRs
descriptionshortening and thesolutionpartners.adobe.comredirect are now in this PR with slightly different wording. The inquirer npm-URL swap in Fix linter warnings in set-up.md #567 is not in this PR (the npm URLs are bot-blocked false positives, similar to helpx). Recommend closing Fix linter warnings in set-up.md #567 once this lands.Test plan
get_started/runtime_getting_started/andguides/runtime_guides/).