Skip to content

docs: align public guidance with current support - #140

Open
rominf wants to merge 5 commits into
mainfrom
docs/public-guidance-cleanup
Open

docs: align public guidance with current support#140
rominf wants to merge 5 commits into
mainfrom
docs/public-guidance-cleanup

Conversation

@rominf

@rominf rominf commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • replace obsolete private-repository installation guidance with the public installer paths
  • document current platform and inference-engine support boundaries
  • update hardware CI documentation to match the existing self-hosted GPU jobs and remove obsolete APE-era wording
  • Why: public documentation still described earlier private and planned states that no longer match the repository
  • Risk: low — documentation and workflow comments only; no CI behavior changes

Test plan

  • prek run --all-files --no-group local-tools
  • verified Markdown headers and relative links
  • cross-checked platform claims against the installers, engine documentation, dashboard transport, and release targets
  • cross-checked hardware job names, runner labels, trigger gates, and blocking behavior against .github/workflows/ci.yml
  • scanned the final diff for stale wording and non-public references

Scope

  • leaves the existing release-trust, security, and contribution policies unchanged because their current-state guidance remains accurate

@rominf
rominf requested review from fredespi and volen-silo July 22, 2026 13:12
@rominf
rominf marked this pull request as ready for review July 22, 2026 13:12
@rominf
rominf marked this pull request as draft July 22, 2026 15:27
@rominf
rominf marked this pull request as ready for review July 22, 2026 15:44
@rominf
rominf force-pushed the docs/public-guidance-cleanup branch 2 times, most recently from 73fb0a1 to 8485d5a Compare July 23, 2026 12:22
@rominf
rominf enabled auto-merge July 23, 2026 12:35
@nowycondro
nowycondro requested review from Copilot and nowycondro July 23, 2026 12:36

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates public-facing documentation to reflect current installer, platform, engine, and CI hardware-testing realities, removing obsolete “private/planned” guidance and aligning wording with the current repository state.

Changes:

  • Clarifies supported platforms/engines in README.md and removes obsolete private-repo install fallbacks.
  • Updates test guidance and CI hardware-testing documentation to match today’s workflow/job topology.
  • Adjusts workflow comments to reflect existing self-hosted GPU E2E jobs (no behavior change).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
README.md Adds an explicit platform support table; removes obsolete private-repo installation fallback sections; tightens platform/engine support wording.
docs/testing.md Removes obsolete APE-era wording from WSL/Linux testing notes.
docs/engine-plugins.md Updates engine plugin guidance around Lemonade/vLLM behavior and fallback policy.
docs/ci-hardware-testing.md Rewrites CI hardware testing doc from “planned” to the current self-hosted GPU E2E job design, triggers, and blocking behavior.
.github/workflows/ci.yml Updates comments describing the existing self-hosted GPU E2E jobs and links to the updated documentation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/engine-plugins.md Outdated
@rominf
rominf changed the base branch from main to ci-shared-windows-strix-runners July 23, 2026 14:25
@rominf
rominf marked this pull request as draft July 23, 2026 14:25
auto-merge was automatically disabled July 23, 2026 14:25

Pull request was converted to draft

@rominf
rominf force-pushed the ci-shared-windows-strix-runners branch from bb89ce9 to cf10418 Compare July 24, 2026 12:23
Base automatically changed from ci-shared-windows-strix-runners to main July 27, 2026 15:14
@rominf
rominf force-pushed the docs/public-guidance-cleanup branch from 35afa01 to 6625d97 Compare July 28, 2026 08:29
rominf added 5 commits July 28, 2026 12:22
Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
Both inputs are wired only into the three self-hosted GPU jobs
(e2e-gpu, e2e-gpu-strix-ubuntu, e2e-gpu-strix-windows) in
.github/workflows/ci.yml; the mock job (platform=mock) reads
neither and always runs its full suite.

Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
Vulkan is selected when the ROCm backend is unsupported; only CPU
has no fallback.

Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
@rominf
rominf force-pushed the docs/public-guidance-cleanup branch from 6625d97 to ceb48cd Compare July 28, 2026 13:34
@rominf
rominf marked this pull request as ready for review July 29, 2026 06:48
@rominf
rominf requested a review from a team July 29, 2026 09:45
@rominf
rominf added this pull request to the merge queue Jul 31, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants