Skip to content

docs: refresh READMEs for the Linux release; skip heavy Linux CI on docs-only PRs - #46

Merged
Negative-Star-Innovators merged 1 commit into
mainfrom
docs/readme-linux-release-refresh
Oct 1, 2026
Merged

Negative-Star-Innovators merged 1 commit into
mainfrom
docs/readme-linux-release-refresh

Conversation

@Negative-Star-Innovators

Copy link
Copy Markdown
Owner

Post-Linux-release README refresh + a CI cost fix. No code changes.

Root README

  • Platform-neutral intro and feature bullets (dropped the WinUI 3 / Store+Velopack Windows-centric bullets; added works-with-any-agent, per-user install + headless systemd, auto-updates)
  • Install section moved before Documentation, split into ### Windows / ### Linux
  • Fixed the Linux update wording: GUI installs self-update in-app (startup check, "Restart now / later", Settings button — verified in linux/gui/main_window.cpp and linux/README.md); only headless installs use agentredactor status → agentredactor update → systemctl --user restart agentredactor
  • Repository layout: added linux/, website/, docs/; corrected the core/ row (built by both platforms now); refreshed tests/scripts/CI rows
  • Standalone Prerequisites removed, folded into per-platform Building subsections; added the Linux build (apt + onnxruntime tarball + cmake)
  • Tests rewritten for the cross-platform reality: cli/, migration/, linux/ run on every PR; Windows FlaUI suite via the dispatched Tests workflow

windows/README.md

  • License: Proprietary → MIT (points at ../LICENSE)
  • Self-release model path/endpoint corrected: %LOCALAPPDATA%\AgentRedactor\models via api.agentredactor.../models (verified against core/src/model_downloader.cpp)
  • Dropped stale windows-app-openai references and the MSI claim (verified: no MSI/WiX logic in any build script); added buildquick.ps1 note and the 53-language feature

linux/README.md

  • Cross-link to root README for end users; named the models endpoint URL; added MIT license section

.github/workflows/build-linux.yml

  • Added the docs-only changes gate already used by build-msix.yml / release-selfrelease.yml: README-only PRs now skip the full Linux pipeline (both arches) while the per-arch build (x64)/build (arm64) checks still report success for the branch ruleset. Manual dispatches always build; publish gating unchanged.

Notes

  • Docs + CI only — no version bump, no release impact (per windows/AGENTS.md, docs changes ship in no release artifact)
  • Workflow YAML validated (safe_load parse); all diffs reviewed line-by-line
  • "53 languages" verified accurate: 53 entries in SUPPORTED_LANGUAGES, all with windows/Strings dirs; Linux has 52 .ts catalogs (English needs none)

…ocs-only PRs

Root README:
- platform-neutral intro/feature bullets (drop the WinUI 3 and Store/Velopack
  Windows-centric bullets)
- Install section first, split into Windows/Linux subsections; fix the Linux
  update wording (GUI installs self-update in-app; only headless installs use
  `agentredactor update` + `systemctl --user restart`)
- Repository layout: add linux/, website/, docs/; correct the core/ row;
  refresh tests/scripts/CI rows
- fold Prerequisites into per-platform Building subsections and add the Linux
  build instructions
- rewrite Tests for the cross-platform suites

windows/README.md: license Proprietary -> MIT (points at ../LICENSE); fix
self-release model path/endpoint (%LOCALAPPDATA%\AgentRedactor\models via the
R2 models endpoint, per core/src/model_downloader.cpp); drop stale
windows-app-openai references and the MSI claim (no MSI/WiX in any build
script); add buildquick.ps1 note and the 53-language feature.

linux/README.md: cross-link root README for end users; name the models
endpoint URL; add MIT license section.

build-linux.yml: add the docs-only `changes` gate used by build-msix.yml and
release-selfrelease.yml so README-only PRs skip the full Linux pipeline while
still reporting the per-arch build checks the branch ruleset requires.
Manual dispatches always build.

No code changes; no release impact.
@Negative-Star-Innovators
Negative-Star-Innovators merged commit 63d6140 into main Oct 1, 2026
18 checks passed
@Negative-Star-Innovators
Negative-Star-Innovators deleted the docs/readme-linux-release-refresh branch October 1, 2026 01:57
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.

1 participant