Skip to content

Fix broken local paths in docs/engine/testing/Testing-the-engine.md #185701

Merged
andywolff merged 1 commit into
flutter:masterfrom
andywolff:engine_docs_link_fix
Apr 29, 2026
Merged

Fix broken local paths in docs/engine/testing/Testing-the-engine.md #185701
andywolff merged 1 commit into
flutter:masterfrom
andywolff:engine_docs_link_fix

Conversation

@andywolff
Copy link
Copy Markdown
Contributor

Fix broken local paths in docs/engine/testing/Testing-the-engine.md.

This file was moved from /engine/src/flutter/ to /docs/engine/ in #175195 but these local links were not updated. So let's update the paths to be relative to the repository root.

No issue since this is a trivial docs change

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I signed the [CLA].
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
  • All existing and new tests are passing.

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Apr 28, 2026
@github-actions github-actions Bot added engine flutter/engine related. See also e: labels. team-engine Owned by Engine team d: docs/ flutter/flutter/docs, for contributors labels Apr 28, 2026
@andywolff andywolff requested a review from jtmcdole April 28, 2026 20:05
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates documentation links in docs/engine/testing/Testing-the-engine.md by replacing relative paths with absolute paths. The review feedback highlights that these absolute paths will break when viewed on GitHub because they resolve relative to the domain root rather than the repository root. It is recommended to revert to relative paths to ensure link portability and correctness across different environments.

Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
@andywolff andywolff removed the request for review from jtmcdole April 28, 2026 20:20
@andywolff andywolff force-pushed the engine_docs_link_fix branch from 70056af to 8358bce Compare April 28, 2026 20:22
@github-actions github-actions Bot removed the CICD Run CI/CD label Apr 28, 2026
@andywolff andywolff marked this pull request as draft April 28, 2026 20:23
@andywolff andywolff marked this pull request as ready for review April 28, 2026 20:45
@andywolff andywolff requested a review from jtmcdole April 28, 2026 20:45
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates various file paths within the 'docs/engine/testing/Testing-the-engine.md' documentation to point to the engine source code. The reviewer identified that these relative paths are invalid in the context of the 'flutter/flutter' repository and suggested replacing them with absolute URLs to the 'flutter/engine' repository to ensure they remain functional.

Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
Comment thread docs/engine/testing/Testing-the-engine.md
@jtmcdole
Copy link
Copy Markdown
Member

I think links when viewed locally will be broken... but I don't have numbers on how often links are viewed locally or on github.

@andywolff
Copy link
Copy Markdown
Contributor Author

andywolff commented Apr 28, 2026

I think links when viewed locally will be broken... but I don't have numbers on how often links are viewed locally or on github.

When I preview the file with VSCode, these links resolve correctly. If there is a different way of viewing locally which has an issue, let's address in a followup. I'll merge for now.

This file was moved from /engine/src to /docs/engine/, so let's update the paths to be relative to the repository root
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD d: docs/ flutter/flutter/docs, for contributors engine flutter/engine related. See also e: labels. team-engine Owned by Engine team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants