Skip to content

Rewrite README prose - #396

Merged
aspizu merged 1 commit into
mainfrom
apz/rewrite-readme-prose
Oct 8, 2026
Merged

aspizu merged 1 commit into
mainfrom
apz/rewrite-readme-prose

Conversation

@aspizu

@aspizu aspizu commented Oct 7, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Rewrote the README prose for clarity, grammar and flow while keeping all links, images, badges, headings and facts intact.
  • Converted the run-on "modern tooling" paragraph into a scannable bulleted list.
  • Made the abstractions list parallel and consistently punctuated.
  • Polished the Prior Art, Contributing and FOSS HACK 25 sections.
  • Removed the Sister Projects section (it duplicated the header nav links).
  • Formatted the embedded HTML blocks consistently.

Details

  • Intro: fixed the "Write Scratch projects in text, and compile it into..." grammar inconsistency.
  • Tooling: the chain of choppy sentences ("Use a version-control system such as git. Use VS Code...") is now a bullet list; the standard library mention links to its repo.
  • Abstractions: "more than just an 1:1 mapping" → "goes beyond a 1:1 mapping"; bullets now use consistent capitalization and punctuation.
  • Prior Art: "presented the demoscene discord with his project" → "presented his project to the demoscene Discord"; untangled the boiga description.
  • FOSS HACK 25: fixed "a open-source" → "an open-source" and the awkward "I had worked on... feature implementation" tense.
  • HTML: the nav <p> now closes on its own line and is separated from the <picture> block; the logo <img> got an empty alt and the self-closing style used elsewhere; the Star History block uses two-space indentation.

No links, images or factual claims were added or removed.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-08T06:35:10.756568Z 9bf19f4 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0e551e345b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
- [IDE](https://github.com/aspizu/goboscript-ide): Online IDE for goboscript, runs projects instantly in the browser.
- [MCP Server](https://github.com/aspizu/goboscript-mcp): Connects AI coding agents to the compiler and Turbowarp Desktop.

## Prior Art

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore the unintentionally removed Sister Projects section

This deletion removes the entire Sister Projects section even though the commit describes only removing its MCP Server entry while preserving the other links and polishing the section. In particular, the goboscript-ide source repository is no longer linked anywhere in the README—the remaining IDE link opens the hosted application—so readers lose the documented route to that sister project's source. Restore the section and omit only the intentionally removed MCP entry.

Useful? React with 👍 / 👎.

@aspizu
aspizu force-pushed the apz/rewrite-readme-prose branch from fe07ce9 to 9bf19f4 Compare October 8, 2026 06:34
@aspizu
aspizu merged commit 41907d3 into main Oct 8, 2026
1 check passed
@aspizu
aspizu deleted the apz/rewrite-readme-prose branch October 8, 2026 06:34
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