Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: CI

on:
pull_request:
branches: [main]
push:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: '22'
cache: npm

- run: npm ci

- run: npm audit --omit=dev

- run: npm run build
40 changes: 40 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Agent Reference Guide

This repository is the **source of truth for Next Commerce user documentation**. It is
public so developers, agencies, and AI agents can clone it locally and reference
accurate product docs while building on the platform.

## What to read

| Need | Where to look |
|------|----------------|
| Merchant & operator guides (setup, payments, orders, campaigns, apps) | `content/docs/` |
| Published release history | `content/changelog/` |
| Live site (canonical rendered output) | [docs.nextcommerce.com](https://docs.nextcommerce.com) |
| Admin API, Campaigns SDK, webhooks, themes, GraphQL | [developers.nextcommerce.com](https://developers.nextcommerce.com) — separate repo |

Start with `content/docs/index.mdx` and `content/docs/about-next.mdx` for platform
overview, then follow the section structure under `content/docs/`.

## What to ignore

Unless you are maintaining the docs site itself, skip:

- `app/`, `components/`, `lib/` — Next.js/Fumadocs site implementation
- `scripts/changelog-migration/` — historical one-time migration tooling (deprecated)
- `redirects/` — legacy changelog redirect worker
- `docs/MAINTENANCE.md` — internal team publishing notes

## Conventions

- User docs paths use the `/docs/...` URL prefix on the live site (e.g.
`/docs/features/payments/google-pay`).
- Link to Developer Docs for API, SDK, webhook, and theme implementation details
rather than duplicating them here.
- Prefer current paths under `/docs/start-here/get-started/` (not legacy
`get-started-on-29-next` URLs found in older changelog entries).

## Maintenance

This repository is maintained by the NEXT team only. External pull requests are
not accepted. See `README.md` and `docs/MAINTENANCE.md`.
32 changes: 17 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# Contributing

Thanks for helping improve Next Commerce Docs.
This repository is **maintained by the NEXT team only**. External contributions
are not accepted.

## Content guidelines
## Why this repo is public

- Write for merchants, agencies, developers, and operators who are using the platform.
- Keep instructions specific and task-oriented.
- Link to [Developer Docs](https://developers.nextcommerce.com) for API, SDK, webhook, and theme implementation details.
- Do not include customer data, private merchant examples, credentials, account screenshots, internal tickets, or private GitHub links.
- Prefer public product names and stable public URLs.
The repository is public so developers and AI agents can clone it locally and
reference Next Commerce user documentation while building on the platform. See
[`AGENTS.md`](AGENTS.md) for agent-oriented guidance.

## Pull requests
## Content standards

1. Create a branch from `main`.
2. Make the smallest focused change that solves the documentation issue.
3. Run `npm run build`.
4. Open a pull request with a short summary and any relevant screenshots for visual changes.
When editing docs as a team member:

For changelog entries, follow `content/changelog.README.md`.
- Write for merchants, agencies, developers, and operators using the platform.
- Link to [Developer Docs](https://developers.nextcommerce.com) for API, SDK,
webhook, and theme implementation details.
- Do not include customer data, credentials, internal tickets, or private GitHub links.

## Security and sensitive content
Team workflow and publishing details: [`docs/MAINTENANCE.md`](docs/MAINTENANCE.md).

Do not report security vulnerabilities or leaked sensitive content in a public issue. Follow `SECURITY.md` instead.
## Security

Do not report security vulnerabilities or leaked sensitive content in a public
issue. Follow [`SECURITY.md`](SECURITY.md) instead.
11 changes: 11 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Copyright (c) Next Commerce

All rights reserved.

You may clone this repository and use its documentation content locally as a
reference while building on the Next Commerce platform, including ingestion by
AI coding agents for that purpose.

Redistribution, modification, or republication of this content outside of local
development reference is not permitted without written permission from Next
Commerce.
67 changes: 0 additions & 67 deletions PUBLICATION_READINESS.md

This file was deleted.

47 changes: 32 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# Next Commerce Docs

This repository powers [docs.nextcommerce.com](https://docs.nextcommerce.com), the public user documentation and changelog for the Next Commerce platform.
Public source for [docs.nextcommerce.com](https://docs.nextcommerce.com) — the user
documentation and changelog for the Next Commerce platform.

Developer API documentation lives separately at [developers.nextcommerce.com](https://developers.nextcommerce.com).
**Primary audience for this public repo:** developers and AI agents who clone it
locally to reference accurate product docs while building stores, integrations,
and campaigns on Next Commerce. The live site remains the canonical rendered
experience.

API, SDK, webhook, and theme documentation lives separately at
[developers.nextcommerce.com](https://developers.nextcommerce.com).

AI agents: see [`AGENTS.md`](AGENTS.md) for which paths to read and which to skip.

## What lives here

- `content/docs/` contains merchant and operator guides.
- `content/changelog/` contains published changelog entries.
- `app/`, `components/`, and `lib/` contain the Next.js/Fumadocs site.
- `scripts/` contains content validation and historical migration utilities.
- `redirects/` contains the legacy changelog redirect worker.
| Path | Purpose |
|------|---------|
| `content/docs/` | Merchant and operator guides — **main reference surface** |
| `content/changelog/` | Published changelog entries |
| `app/`, `components/`, `lib/` | Next.js/Fumadocs site (maintainers only) |
| `scripts/` | Link validation and legacy migration utilities |
| `redirects/` | Legacy changelog redirect worker |

## Local development

Expand All @@ -23,15 +34,15 @@ npm run dev

The local site runs at `http://localhost:3000` by default.

## Validation
## Validation (NEXT team)

Before opening a pull request, run:
Before merging changes to `main`, run:

```sh
npm run build
```

The build also runs the docs link checks:
The build also runs docs link checks:

- `npm run audit-developer-links`
- `npm run validate-links`
Expand All @@ -40,17 +51,23 @@ Run `npm audit --omit=dev` when touching dependencies.

## Publishing

The production site is statically exported by Next.js and deployed to Cloudflare Workers assets using `wrangler.jsonc`.
The production site is statically exported by Next.js and deployed to Cloudflare
Workers assets using `wrangler.jsonc`. See [`docs/MAINTENANCE.md`](docs/MAINTENANCE.md)
for team workflow details.

## Contributing

Normal content changes should land through pull requests. Changelog entries should be added as MDX files under `content/changelog/` with frontmatter matching `source.config.ts`.
This repository is **maintained by the NEXT team only**. External contributions
are not accepted. See [`CONTRIBUTING.md`](CONTRIBUTING.md).

## Public Repository Notes
## Public clone safety

This repo is intended to be safe for public cloning by agencies, developers, merchants, and AI agents. Do not commit:
Do not commit:

- customer data, private merchant names, screenshots with account data, or support artifacts
- API keys, `.env` files, tokens, credentials, or private keys
- internal planning docs, private GitHub project exports, or sprint-only engineering notes
- staging-only URLs unless they are part of a documented public workflow

If a change depends on private operational context, keep that context in an internal repository and link only to public, stable documentation here.
If a change depends on private operational context, keep that context in an
internal repository and link only to public, stable documentation here.
14 changes: 11 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,21 @@

## Reporting a Vulnerability

Do not open a public GitHub issue for vulnerabilities, exposed credentials, private customer data, or other sensitive reports.
Do not open a public GitHub issue for vulnerabilities, exposed credentials,
private customer data, or other sensitive reports.

Use GitHub private vulnerability reporting if it is enabled for this repository. If that is unavailable, contact your Next Commerce representative and include:
Use GitHub private vulnerability reporting if it is enabled for this repository.
If that is unavailable, contact your Next Commerce representative and include:

- the affected page, file, or URL
- what sensitive data or behavior is exposed
- steps to reproduce, if safe to share privately
- whether the issue appears in the live site, the repository, or both

This repository is public for documentation reference (including AI agent
clones). Security reports about the docs content or site are welcome through
the channels above.

## Sensitive Content Rules

This repository should not contain:
Expand All @@ -20,4 +26,6 @@ This repository should not contain:
- internal-only sprint notes, private GitHub project exports, or private incident notes
- unpublished security procedures that would increase risk if disclosed

If sensitive content is committed, treat the repository history as exposed once the repository is public. Remove the content, rotate any affected credentials, and review the exposure window before publishing.
If sensitive content is committed, treat the repository history as exposed.
Remove the content, rotate any affected credentials, and review the exposure
window.
14 changes: 6 additions & 8 deletions content/changelog.README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,11 @@ Standard MDX. Recommended structure:
Use any MDX/fumadocs components — the same `getMDXComponents` map that powers
`/docs` is applied.

## Content Factory integration
## Publishing (NEXT team)

The Factory watches this folder for new files on `main`. When a PR lands that
adds `content/changelog/*.mdx`, the Factory picks up the frontmatter + body and
fans it out to Slack, social, and email. The webhook contract is documented in
`next-mind/designs/content-factory-above-layer1.md` — this migration's only job
was to put entries on a stable git-watchable path.
Add entries as MDX files under `content/changelog/` on `main`. New files are
picked up by internal release automation. See `docs/MAINTENANCE.md` for the
full team workflow.

**Stable path for Factory:** `content/changelog/*.mdx` on the default branch of
`NextCommerceCo/docs`.
Use stable public URLs when linking to docs pages (`https://docs.nextcommerce.com/docs/...`)
and developer docs (`https://developers.nextcommerce.com/docs/...`).
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ summary: Platform update on June 29, 2020.
- Dashboard Redirect Management
- Dashboard Payments Settings
- Dashboard ShipHero Extension Settings
- [Admin API](https://developers.nextcommerce.com/docs/admin-api) now supports creating orders, see[ Admin API Docs](https://api-docs.Next Commerce.com/api/docs/admin/#operation/orders_create). Payment methods on the admin api are currently limited while this API endpoint continues to be developed.
- [Admin API](https://developers.nextcommerce.com/docs/admin-api) now supports creating orders, see[ Admin API Docs](https://api-docs.nextcommerce.com/api/docs/admin/#operation/orders_create). Payment methods on the admin api are currently limited while this API endpoint continues to be developed.
- Subscription renewal decline now includes decline code and description to easily see the failure reason.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ summary: Introducing Tax features with the ability to configure Tax Rates and Ta

- Improved support for Stripe Error Codes when payment methods are invalid to map with our Transaction Response codes.
- Added on the API for Address Title fields to support Klarna's Title field so it is prepopulated in the Klarna widget on for improved checkout experience.
- We now have a fallback to send email from [noreply@Next Commerce.com](mailto:noreply@Next Commerce.com) when a store does not have any verified email sending domains or the user has misconfigured the store "FROM" email address using an unverified domain.
- We now have a fallback to send email from [noreply@nextcommerce.com](mailto:noreply@nextcommerce.com) when a store does not have any verified email sending domains or the user has misconfigured the store "FROM" email address using an unverified domain.

## Bug Fixes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ summary: App Framework is now in public beta paving the way for third-party deve

## New Features

- App Framework is now in public beta paving the way for third-party developers to build reusable apps to extend storefronts and core platform logic, [see Apps documentation](https://developers.Next Commerce.com/apps/).
- App Framework is now in public beta paving the way for third-party developers to build reusable apps to extend storefronts and core platform logic, [see Apps documentation](https://developers.nextcommerce.com/apps/).
- We now have an App available on [Make.com](https://www.make.com/en/integrations/twentyninenext) to easily integrate 100s of services and create custom workflows.
- Transactions list view and reports can now be filtered by Card Brand to improve workflows for card brand transaction reporting.
- The `phone_number` field on the [Admin API](https://developers.nextcommerce.com/docs/admin-api) now accepts local numbers and will automatically convert them to E.164 format based on the user's first address country.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ summary: "Introducing a new integration with [Gorgias](https://www.gorgias.com/)

## New Features

- Introducing a new integration with [[Gorgias](https://docs.nextcommerce.com/docs/apps/gorgias)](https://www.gorgias.com/) that is available to install on stores from the Apps menu.
- Introducing a new integration with [Gorgias](https://docs.nextcommerce.com/docs/apps/gorgias) that is available to install on stores from the Apps menu.
- Introducing [Bancontact Payments](https://stripe.com/docs/payments/bancontact) through Stripe as an alternative payment method in the Checkout flow and [Admin API](https://developers.nextcommerce.com/docs/admin-api).
- Offers can now be "cloned" making it easier to duplicate offers without needing to manually fill out the form fields.
- Admin API and [Webhooks](https://developers.nextcommerce.com/docs/webhooks) are now versioned with the default version "2023-02-10". More documentation will follow as new versions of the Admin API and Webhooks are introduced.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ summary: Products have been overhauled, with the introduction of a more streamli
## New Features

- Products have been overhauled, with the introduction of a more streamlined UX to simplify product variant management, product attributes, and overall product catalogue management.
- The [Admin API](https://developers.nextcommerce.com/docs/admin-api) now has a full set of [User Address APIs ](https://developers.Next Commerce.com/docs/api/admin/reference/#tag/customers/operation/usersAddressesCreate)to create and manage addresses.
- The [Admin API](https://developers.nextcommerce.com/docs/admin-api) now has a full set of [User Address APIs ](https://developers.nextcommerce.com/docs/admin-api/reference/#tag/customers/operation/usersAddressesCreate)to create and manage addresses.
- The PayPal integration now integrates [PayPal FraudNet](https://developer.paypal.com/limited-release/fraudnet/integrate/) to provide expanded transaction and device data on PayPal transactions.

## Improvements
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ summary: Payment Gateways and Gateway Groups are now available on the Admin API

## New Features

- Payment [Gateways](https://developers.Next Commerce.com/docs/api/admin/reference/#tag/payments/operation/gatewaysList) and [Gateway Groups ](https://developers.Next Commerce.com/docs/api/admin/reference/#tag/payments/operation/gatewayGroupsList)are now available on the [Admin API](https://developers.nextcommerce.com/docs/admin-api) to list and retrieve their details.
- [Shipping Methods](https://developers.Next Commerce.com/docs/api/admin/reference/#tag/fulfillment/operation/shippingMethodsList) are now available on the Admin API to list and retrieve their details.
- Payment [Gateways](https://developers.nextcommerce.com/docs/admin-api/reference/#tag/payments/operation/gatewaysList) and [Gateway Groups ](https://developers.nextcommerce.com/docs/admin-api/reference/#tag/payments/operation/gatewayGroupsList)are now available on the [Admin API](https://developers.nextcommerce.com/docs/admin-api) to list and retrieve their details.
- [Shipping Methods](https://developers.nextcommerce.com/docs/admin-api/reference/#tag/fulfillment/operation/shippingMethodsList) are now available on the Admin API to list and retrieve their details.

## Improvements

Expand Down
Loading
Loading