Skip to main content

New project path

Follow the complete path from an idea to the first normal release.

Start every public project through the same sequence.

1. Define the product

Write one sentence that states the user, problem, and concrete outcome. Choose a repository profile. Select package names and the final documentation domain before publication.

2. Create from a starter

Create the repository from the matching tested starter. Replace every declared placeholder. Remove features that the product does not need. Do not leave inactive release or deployment paths in the repository.

3. Prove the repository locally

Run the standard commands. Inspect the packed package from a temporary consumer project. Build the documentation app from a clean install.

4. Configure GitHub

Protect main. Require the normal CI, security, and deployment checks. Create the protected npm environment for a library. Add a required reviewer. Allow GitHub Actions to create pull requests when the version workflow needs that permission.

5. Configure external services

Connect Vercel with docs/ as the Root Directory. Add the canonical domain. Create a Plausible site and commit its real script ID. Confirm the Discord, legal, and privacy links.

6. Rehearse before publication

Open a real pull request. Confirm package previews, CodeRabbit, CI, Vercel, and all required checks. Run the production acceptance checklist on the canonical site.

7. Bootstrap npm once

Publish the first version from the exact certified tarball. Then bind the package to its publish.yml trusted publisher. Every later version uses the protected OIDC workflow.

8. Prove the normal release

Publish one patch through the normal workflow. Confirm npm provenance, the dist-tag, the rendered README, the GitHub tag, and the GitHub release. A starter is not proven until this full path succeeds.