Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Missing docs/commands?

Open
#177 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start with the linked quick-start guide and run npm create platformatic@latest to compare its current output with the documented prompts, folders, and migration commands. Check the generated project structure and correct the guide so its instructions match the current generator; done means a new user can follow the guide without encountering the reported discrepancies.

Written by the indexing model from the issue text.

Description

Hi,

I'm following your guide
https://platformatic.dev/docs/getting-started/quick-start-guide

I don't know if it's me or something is missing. For example:
npm create platformatic@latest

The output is different:

  • No "Where would you like to create your project? => ."
  • No "What port do you want to use? => 3042"

Create a Database Schema

"Navigate to the migrations directory within the services"
There is no service folder in the generated code.

Apply Schema Migrations

"In your web/db directory"
No db folder, maybe something is missing when creating @platformatic/db?

npx $ platformatic db migrations apply
I think it should be
$ npx platformatic db migrations apply

etc.

Dominant language
JavaScript
Stars
6
Forks
23
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from platformatic/docs

All issues in platformatic/docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.