LearnNewsExamplesServices
Frontmatter
titleCreate a Modern Getting Started Guide
authorMariam-Saeed
stateMerged
createdAtOct 2, 2025, 2:06 AM
updatedAtOct 8, 2025, 3:26 PM
closedAtOct 8, 2025, 3:26 PM
mergedAtOct 8, 2025, 3:26 PM
branchesdev ← Create-a-Modern-Getting-Started-Guide
urlhttps://github.com/neomjs/neo/pull/7323
Merged
Mariam-Saeed
Mariam-Saeed commented on Oct 2, 2025, 2:06 AM

Please make sure to read the Contributing Guidelines:

https://github.com/neomjs/neo/blob/dev/CONTRIBUTING.md

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe: Documentation

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the main branch
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information: resolves #7297

tobiu
tobiu commented on Oct 8, 2025, 3:25 PM

Feedback from Gemini added. If you like, you can add a comment to the follow-up ticket, and I will assign it to you. For now, I assigned it to me and did not add the hacktoberfest label, to ensure that others don't immediately jump on it.

Sorry for the delay of the review. A lot is going on inside the repo and I am starting to become a bottleneck. Thank you for your first-time contribution!

[You could try out the ai native workflow for the follow-up ticket, if you like (optional).]

✦ This is fantastic work, thank you so much for this detailed and well-written guide! It's clear you put a lot of effort into this, and it's a massive improvement that will help many new developers get started with Neo.mjs.

We are definitely accepting this PR.

As a quick follow-up, there are a few minor formatting tweaks needed to get the guide to render perfectly in our learning portal (our rendering engine has some specific requirements for code blocks, etc.).

We've created a new ticket that details these small changes: https://github.com/neomjs/neo/issues/7417

It's a perfect, easy first-or-second contribution for Hacktoberfest. If you're interested, we would be happy to assign it to you! If not, no worries at all, we can take care of it.

Thanks again for this excellent contribution.