Skip to content

Say milestones 0 to 4 are complete and the DocC site is published (README, docs) - #138

Merged
alaineid merged 1 commit into
mainfrom
readme-status-refresh
Oct 6, 2026
Merged

alaineid merged 1 commit into
mainfrom
readme-status-refresh

Conversation

@alaineid

@alaineid alaineid commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Docs only. Brings the README's status lines, and the two docs that repeat the GitHub Pages line, up to date with main before the project is advertised. No Swift, fixture or workflow file changes.

Every state below was read on 2026-10-06 with ghp issue view N --repo Algorythm-Canada/OpenJevSwift --json state,title, ghp pr list and curl, once before editing and again right before opening this pull request.

The stale lines

1. README.md, Status (line 72)

2. README.md, "Not there yet" (line 81): checked, unchanged

3. README.md, Documentation (line 112)

  • Was: "The Documentation workflow builds them whenever the sources change and, once GitHub Pages is enabled for the repository, publishes them to https://algorythm-canada.github.io/OpenJevSwift/."
  • Now: "The Documentation workflow builds them whenever the sources change and publishes them to https://algorythm-canada.github.io/OpenJevSwift/."
  • Evidence: curl -s -o /dev/null -w '%{http_code}' https://algorythm-canada.github.io/OpenJevSwift/ prints 200. The Pages API (ghp api repos/Algorythm-Canada/OpenJevSwift/pages) reports build_type: workflow. The Documentation run for d25223a (run 37486332329) ran Deploy to GitHub Pages successfully at 15:30 UTC; it is one of 15 github-pages deployments since 2026-10-02.

4. docs/09-conformance-and-testing.md (line 367)

5. docs/README.md (line 34), not in the original list

  • Was: "[...] and the Documentation workflow publishes it to https://algorythm-canada.github.io/OpenJevSwift/ once GitHub Pages is enabled for the repository."
  • Now: "[...] and the Documentation workflow publishes it to https://algorythm-canada.github.io/OpenJevSwift/."
  • Why it is here: it is the same stale sentence, split across a line break ("once" / "GitHub Pages is enabled"), so a one-line search misses it, and docs/README.md is the index of the design documents that the README links to.
  • Evidence: as in 3.

docs/06-decisions.md is left alone: D-047 records what was true when it was written.

Found, not changed here

Checks

  • make lint passes.
  • Docs only, and no test or script reads these three files, so the full swift test was not run.
  • No em dashes; no added line over 100 columns; the "independent project" paragraph is untouched.

Milestone 4's tracking issue #42 and its work issues #43 to #48 are closed, so the README's
Status says milestones 0 to 4 are complete instead of milestone 4 in progress. The Verdict, Laya,
JevBench comparison, calibration report and JevK5 facts keep their numbers. The "Not there yet"
list is unchanged: #50 to #53, #59 and #65 are open, and the generation pull request for #50 to
#52 has not merged.

GitHub Pages serves the site the Documentation workflow deploys from main, so the README,
docs/README.md and docs/09-conformance-and-testing.md say the workflow publishes it there instead
of "once GitHub Pages is enabled". D-047 keeps its wording: a decision records what was true when
it was written.
Copilot AI balanced review requested due to automatic review settings October 6, 2026 15:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The documentation-only updates match the completed milestone and successful main-branch documentation deployment.

Review effort: Balanced
Findings: None

What changed in this PR

Updates project status and documentation links to reflect milestone 4’s completion and the active DocC site.

Changes:

  • Marks milestones 0–4 complete.
  • Removes obsolete GitHub Pages enablement caveats.
  • Adds the published DocC URL to conformance documentation.
File Description
README.md Updates milestone and documentation status.
docs/​README.md Reflects active DocC publishing.
docs/​09-conformance-and-testing.md Records the published documentation URL.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@alaineid
alaineid merged commit 4194e02 into main Oct 6, 2026
1 check passed
@alaineid
alaineid deleted the readme-status-refresh branch October 6, 2026 15:52
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.

2 participants