Skip to content

Improve readme#238

Merged
Jordonbc merged 22 commits intoDevfrom
Improve-Readme
May 1, 2026
Merged

Improve readme#238
Jordonbc merged 22 commits intoDevfrom
Improve-Readme

Conversation

@Jordonbc
Copy link
Copy Markdown
Collaborator

@Jordonbc Jordonbc commented May 1, 2026

No description provided.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

Review Findings

  • Important | README.md line 17‑275: Almost every CI badge, release link, and “Quick Start” download/clone instruction now points at https://github.com/Jordonbc/OpenVCS, which is a different repository than this one (Open-VCS/OpenVCS). That redirects users away from the official builds and renders the release/installer links inaccurate. Please keep these badges and instructions pointing at the Open-VCS/OpenVCS repositories/releases so the docs describe the same source that is being reviewed. Confidence: High.
  • Important | README.md line 142‑147: The “Build from source” script does cd OpenVCS/Client before running frontend/backend steps, but this repo has Frontend//Backend/ at the root—there is no Client/ directory. Following these instructions currently fails. Update the instructions to use the correct paths (e.g., cd OpenVCS or cd Frontend/Backend directly) so contributors can build from source again. Confidence: High.

New%20session%20-%202026-05-01T19%3A39%3A26.741Z
opencode session  |  github run

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

Review Findings

  • Important: README.md now points all badges, release downloads, and cloning instructions at https://github.com/Open-VCS/OpenVCS (lines 17, 101, 142), but the installer (install.sh lines 12‑178), channel metadata (channel-metadata.json lines 1‑34), and the updater endpoints in Backend/tauri.conf.json (lines 76‑85) still target https://github.com/Jordonbc/OpenVCS. As soon as someone follows the new Quick Start, they’ll fetch artifacts from the Open-VCS org but the shipped updater/installer are still wired to the old repo, so installations will either fail or continue to update from a different source than the README claims. Please align the installer/updater metadata with Open-VCS/OpenVCS (or keep the README pointing at the repo the binaries actually publish from) so the documentation matches the runnable flow. Confidence: High.
  • No other blocking or important issues found.

New%20session%20-%202026-05-01T19%3A44%3A13.669Z
opencode session  |  github run

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

No blocking or important issues were found in README.md or docs/Features.md; the updates are purely documentation and keep the content factual relative to the existing product state.

New%20session%20-%202026-05-01T19%3A47%3A14.141Z
opencode session  |  github run

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

  • Reviewed the README and new docs/Features.md; the updates are purely documentation and don’t introduce any correctness/regression issues.
  • No blocking or important concerns were found in this pull request.

New%20session%20-%202026-05-01T19%3A50%3A43.483Z
opencode session  |  github run

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

  • Important: README’s Quick Start now points at https://github.com/Open-VCS/OpenVCS/releases/latest (README.md:109‑132) but the runtime metadata still references https://github.com/Jordonbc/OpenVCS (channel-metadata.json: repo/updaterEndpoints, lines 2‑33; Backend/tauri.conf.json: updater endpoints, lines 76‑85). As soon as someone follows the updated docs they will download from Open-VCS/OpenVCS, yet the built-in updater (and any channel metadata used by flatpak/installer tooling) continues to fetch from the Jordonbc repo, so the actual update flow and release source no longer match the README. Please update the metadata/updater URLs to point at Open-VCS/OpenVCS (or keep the README referring to the repo the binaries actually publish from) so the documentation matches the runnable flow. Confidence: High.

No other blocking or important issues were found in this PR.

New%20session%20-%202026-05-01T19%3A53%3A15.496Z
opencode session  |  github run

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

No blocking or important issues found; the README, docs/Features.md, updater metadata, and Tauri configuration now consistently point at github.com/Open-VCS/OpenVCS, and no new semantic or correctness issues jumped out from the doc/config changes.

New%20session%20-%202026-05-01T19%3A58%3A09.197Z
opencode session  |  github run

@Jordonbc Jordonbc merged commit ac16554 into Dev May 1, 2026
7 checks passed
@Jordonbc Jordonbc deleted the Improve-Readme branch May 1, 2026 20:07
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