docs: move current status in readme #4

Merged

jwilger merged 1 commit from docs/readme-current-status into main 2026-06-05 14:54:18 -07:00

Conversation 2 Commits 1 Files changed 1 +7 -7

jwilger commented 2026-06-05 14:43:41 -07:00

Owner

Copy link

Rationale

• The README currently buries project status after development commands, making the state of the project harder to find before the formal-methods explanation.
• The formal modeling rules reference should be a navigable Markdown link because readers use it as the acceptance checklist for current EMC work.

Summary

• Move the README Current status section directly after What EMC is for.
• Convert the formal modeling rules path in that section into a working Markdown link.

Verification

• git diff --check
• test -f docs/event-model/formal-modeling-rules.md

Rationale - The README currently buries project status after development commands, making the state of the project harder to find before the formal-methods explanation. - The formal modeling rules reference should be a navigable Markdown link because readers use it as the acceptance checklist for current EMC work. Summary - Move the README Current status section directly after What EMC is for. - Convert the formal modeling rules path in that section into a working Markdown link. Verification - git diff --check - test -f docs/event-model/formal-modeling-rules.md

jwilger added 1 commit 2026-06-05 14:43:41 -07:00

docs: move current status in readme 6d28379f01

auto-review requested changes 2026-06-05 14:43:53 -07:00

Dismissed

auto-review left a comment

Copy link

The PR reorganizes the README by moving the 'Current status' section and converting a file path into a Markdown link. The changes are straightforward and appear safe to merge.

Walkthrough

• The 'Current status' section has been moved to follow the 'What EMC is for' section, improving the logical flow of the README.
• A file path in the 'Current status' section has been converted into a Markdown link, enhancing navigation by allowing direct access to the referenced document.

LLM usage and cost

• Reasoning (gpt-4o) in=1069 out=167 cost=$0.007850
• Cheap (gpt-4o-mini) in=321 out=55 cost=$0.000081
  Estimated total USD: $0.007931 via https://api.openai.com and https://api.openai.com

Pre-merge checks

• PR metadata quality: failed
• Rationale: The PR body starts with 'Summary', which does not provide a clear explanation of why the change is needed. Additionally, the body does not explain the significance of moving the section or converting the link.
• Offending text: Summary

The PR reorganizes the README by moving the 'Current status' section and converting a file path into a Markdown link. The changes are straightforward and appear safe to merge. ## Walkthrough - The 'Current status' section has been moved to follow the 'What EMC is for' section, improving the logical flow of the README. - A file path in the 'Current status' section has been converted into a Markdown link, enhancing navigation by allowing direct access to the referenced document. ## LLM usage and cost - Reasoning (gpt-4o) in=1069 out=167 cost=$0.007850 - Cheap (gpt-4o-mini) in=321 out=55 cost=$0.000081 Estimated total USD: $0.007931 via https://api.openai.com and https://api.openai.com ## Pre-merge checks - PR metadata quality: failed - Rationale: The PR body starts with 'Summary', which does not provide a clear explanation of why the change is needed. Additionally, the body does not explain the significance of moving the section or converting the link. - Offending text: Summary

jwilger force-pushed docs/readme-current-status from 6d28379f01 to 61a1d0d16c 2026-06-05 14:46:25 -07:00 Compare

auto-review approved these changes 2026-06-05 14:46:40 -07:00

auto-review left a comment

Copy link

The PR improves the README by moving the 'Current status' section to a more prominent position and converting a file path into a Markdown link. These changes enhance the document's readability and usability.

Walkthrough

Δ since 6d28379:

• README.md:
  • Moved the 'Current status' section to follow 'What EMC is for'.
  • Converted the path to the formal modeling rules into a Markdown link for easier navigation.

LLM usage and cost

• Reasoning (gpt-4o) in=31273 out=162 cost=$0.158795
• Cheap (gpt-4o-mini) in=378 out=35 cost=$0.000078
  Estimated total USD: $0.158873 via https://api.openai.com and https://api.openai.com

The PR improves the README by moving the 'Current status' section to a more prominent position and converting a file path into a Markdown link. These changes enhance the document's readability and usability. ## Walkthrough ### Δ since 6d28379: - **README.md**: - Moved the 'Current status' section to follow 'What EMC is for'. - Converted the path to the formal modeling rules into a Markdown link for easier navigation. ## LLM usage and cost - Reasoning (gpt-4o) in=31273 out=162 cost=$0.158795 - Cheap (gpt-4o-mini) in=378 out=35 cost=$0.000078 Estimated total USD: $0.158873 via https://api.openai.com and https://api.openai.com

jwilger merged commit fd721c5343 into main 2026-06-05 14:54:18 -07:00

Sign in to join this conversation.

Reviewers

No reviewers

auto-review

Labels

Clear labels

  

bug

Something is not working

  

duplicate

This issue or pull request already exists

  

enhancement

New feature

  

help wanted

Need some help

  

invalid

Something is wrong

  

question

More information is needed

  

wontfix

This won't be fixed

No labels

bug

duplicate

enhancement

help wanted

invalid

question

wontfix

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Slipstream/emc!4

No description provided.