Skip to content

Update README links and headings for clarity#4274

Open
nishagoswamii wants to merge 2 commits intosimstudioai:mainfrom
nishagoswamii:main
Open

Update README links and headings for clarity#4274
nishagoswamii wants to merge 2 commits intosimstudioai:mainfrom
nishagoswamii:main

Conversation

@nishagoswamii
Copy link
Copy Markdown

This pull request makes several small but important updates to the README.md file to improve clarity and ensure external links are correct and up to date.

Documentation improvements:

  • Changed the "Self-hosted" section to clarify that the CLI can be quickly run with npx simstudio, replacing the previous "NPM Package" heading.
  • Updated the link for Ollama to point to the correct website (https://ollama.com) in the local models section.
  • Fixed external links for Fumadocs and Turborepo to use their current domains (fumadocs.dev and turborepo.dev).

Type of Change

  • Documentation

Testing

No automated tests were run because this change is documentation-only and does not affect runtime code.
Reviewers should focus on:
Accuracy of the updated documentation
Clarity and readability for the intended audience
Consistency with existing terminology and style
Any links, commands, or examples for correctness

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Screenshots/Videos

Not applicable for this documentation update.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 2026

@nishagoswamii is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

@cursor
Copy link
Copy Markdown

cursor Bot commented Apr 23, 2026

PR Summary

Low Risk
Low risk documentation-only change; updates headings and external URLs without affecting runtime behavior.

Overview
Improves README.md quickstart clarity by renaming the self-hosted section to CLI (quick run) for npx simstudio.

Refreshes external documentation links, including updating the Ollama URL to https://ollama.com and switching Fumadocs/Turborepo references to their current domains (fumadocs.dev, turborepo.dev).

Reviewed by Cursor Bugbot for commit 0830850. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 23, 2026

Greptile Summary

This PR updates four lines in README.md: renames the "NPM Package" section heading to "CLI (quick run)" for clarity, and corrects three external links — Ollama (ollama.com), Fumadocs (fumadocs.dev), and Turborepo (turborepo.dev) — to their current canonical domains. All updated URLs were verified as live and correct.

Confidence Score: 5/5

Safe to merge — documentation-only change with no runtime impact.

All four changes are documentation corrections with no code impact. Updated URLs were verified against current live domains, and the heading rename accurately reflects the npx simstudio CLI invocation shown in the code block below it.

No files require special attention.

Important Files Changed

Filename Overview
README.md Documentation-only update: fixes heading, corrects Ollama, Fumadocs, and Turborepo URLs to their current canonical domains — all verified correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md Changes] --> B[Section Heading]
    A --> C[External Links]
    B --> D["'NPM Package' → 'CLI (quick run)'"]
    C --> E["ollama.ai → ollama.com ✓"]
    C --> F["fumadocs.vercel.app → fumadocs.dev ✓"]
    C --> G["turborepo.org → turborepo.dev ✓"]
Loading

Reviews (1): Last reviewed commit: "Merge branch 'main' of https://github.co..." | Re-trigger Greptile

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