Theme docs corrections: package, CLI, scopes, theme-kit init and preview

Open
#33 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
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
cli, documentation

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.

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 init flags, that init creates a non-active theme, the preview URL pattern, and the accepted file globs.
Dominant language
MDX
Stars
2
Forks
0
Avg merge
6h 4m
Merged PRs (30d)
13

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 NextCommerceCo/developer-docs

All issues in NextCommerceCo/developer-docs

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.