NextCommerceCo / NextCommerceCo/developer-docs
Theme docs corrections: package, CLI, scopes, theme-kit init and preview
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 2
- Forks
- 0
- Avg merge
- 6h 4m
- Merged PRs (30d)
- 13
Description
Problem: The theme developer docs contradict the released tooling in ways that stop an outside developer at setup: a retired package name in one guide vs the real one in another, a stale theme binary name in getting-started vs ntk everywhere else, inconsistent OAuth scope strings, a nak pash typo in the app extension guide, and a Theme Kit page that documents no init flags, no unpublished-theme semantics, and no preview URL.
Evidence: content/docs/index.mdx (~line 98, theme pull/theme push); content/docs/storefront/themes/theme-kit.mdx (no flags, no preview, no unpublished semantics); scope-string variants across theme-kit.mdx and guides; content/docs/apps/guides/storefront-extension.mdx (nak pash).
Done when:
- One corrective pass aligns every command, package, binary, and scope string with the released CLI and a live dashboard check.
- theme-kit.mdx documents
initflags, thatinitcreates a non-active theme, the preview URL pattern, and the accepted file globs.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with content/docs/index.mdx, content/docs/storefront/themes/theme-kit.mdx, and content/docs/apps/guides/storefront-extension.mdx, comparing package names, binaries, scopes, and the nak pash typo with the released tooling and a live dashboard check. Update the Theme Kit page with the documented init flags, non-active-theme behavior, preview URL pattern, and accepted file globs; done means all listed command and scope inconsistencies are corrected.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100