You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository powers [docs.nextcommerce.com](https://docs.nextcommerce.com), the public user documentation and changelog for the Next Commerce platform.
3
+
Public source for [docs.nextcommerce.com](https://docs.nextcommerce.com) — the user
4
+
documentation and changelog for the Next Commerce platform.
4
5
5
-
Developer API documentation lives separately at [developers.nextcommerce.com](https://developers.nextcommerce.com).
6
+
**Primary audience for this public repo:** developers and AI agents who clone it
7
+
locally to reference accurate product docs while building stores, integrations,
8
+
and campaigns on Next Commerce. The live site remains the canonical rendered
9
+
experience.
10
+
11
+
API, SDK, webhook, and theme documentation lives separately at
AI agents: see [`AGENTS.md`](AGENTS.md) for which paths to read and which to skip.
6
15
7
16
## What lives here
8
17
9
-
-`content/docs/` contains merchant and operator guides.
10
-
-`content/changelog/` contains published changelog entries.
11
-
-`app/`, `components/`, and `lib/` contain the Next.js/Fumadocs site.
12
-
-`scripts/` contains content validation and historical migration utilities.
13
-
-`redirects/` contains the legacy changelog redirect worker.
18
+
| Path | Purpose |
19
+
|------|---------|
20
+
|`content/docs/`| Merchant and operator guides — **main reference surface**|
21
+
|`content/changelog/`| Published changelog entries |
22
+
|`app/`, `components/`, `lib/`| Next.js/Fumadocs site (maintainers only) |
23
+
|`scripts/`| Link validation and legacy migration utilities |
24
+
|`redirects/`| Legacy changelog redirect worker |
14
25
15
26
## Local development
16
27
@@ -23,15 +34,15 @@ npm run dev
23
34
24
35
The local site runs at `http://localhost:3000` by default.
25
36
26
-
## Validation
37
+
## Validation (NEXT team)
27
38
28
-
Before opening a pull request, run:
39
+
Before merging changes to `main`, run:
29
40
30
41
```sh
31
42
npm run build
32
43
```
33
44
34
-
The build also runs the docs link checks:
45
+
The build also runs docs link checks:
35
46
36
47
-`npm run audit-developer-links`
37
48
-`npm run validate-links`
@@ -40,17 +51,23 @@ Run `npm audit --omit=dev` when touching dependencies.
40
51
41
52
## Publishing
42
53
43
-
The production site is statically exported by Next.js and deployed to Cloudflare Workers assets using `wrangler.jsonc`.
54
+
The production site is statically exported by Next.js and deployed to Cloudflare
55
+
Workers assets using `wrangler.jsonc`. See [`docs/MAINTENANCE.md`](docs/MAINTENANCE.md)
56
+
for team workflow details.
57
+
58
+
## Contributing
44
59
45
-
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`.
60
+
This repository is **maintained by the NEXT team only**. External contributions
61
+
are not accepted. See [`CONTRIBUTING.md`](CONTRIBUTING.md).
46
62
47
-
## Public Repository Notes
63
+
## Public clone safety
48
64
49
-
This repo is intended to be safe for public cloning by agencies, developers, merchants, and AI agents. Do not commit:
65
+
Do not commit:
50
66
51
67
- customer data, private merchant names, screenshots with account data, or support artifacts
52
68
- API keys, `.env` files, tokens, credentials, or private keys
Copy file name to clipboardExpand all lines: SECURITY.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,21 @@
2
2
3
3
## Reporting a Vulnerability
4
4
5
-
Do not open a public GitHub issue for vulnerabilities, exposed credentials, private customer data, or other sensitive reports.
5
+
Do not open a public GitHub issue for vulnerabilities, exposed credentials,
6
+
private customer data, or other sensitive reports.
6
7
7
-
Use GitHub private vulnerability reporting if it is enabled for this repository. If that is unavailable, contact your Next Commerce representative and include:
8
+
Use GitHub private vulnerability reporting if it is enabled for this repository.
9
+
If that is unavailable, contact your Next Commerce representative and include:
8
10
9
11
- the affected page, file, or URL
10
12
- what sensitive data or behavior is exposed
11
13
- steps to reproduce, if safe to share privately
12
14
- whether the issue appears in the live site, the repository, or both
13
15
16
+
This repository is public for documentation reference (including AI agent
17
+
clones). Security reports about the docs content or site are welcome through
18
+
the channels above.
19
+
14
20
## Sensitive Content Rules
15
21
16
22
This repository should not contain:
@@ -20,4 +26,6 @@ This repository should not contain:
- unpublished security procedures that would increase risk if disclosed
22
28
23
-
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.
29
+
If sensitive content is committed, treat the repository history as exposed.
30
+
Remove the content, rotate any affected credentials, and review the exposure
Copy file name to clipboardExpand all lines: content/changelog/2020-06-29-admin-api-subscriptions-payments-orders.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,5 +16,5 @@ summary: Platform update on June 29, 2020.
16
16
- Dashboard Redirect Management
17
17
- Dashboard Payments Settings
18
18
- Dashboard ShipHero Extension Settings
19
-
-[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.
19
+
-[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.
20
20
- Subscription renewal decline now includes decline code and description to easily see the failure reason.
Copy file name to clipboardExpand all lines: content/changelog/2020-12-28-admin-api-payments-checkout-orders.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ summary: Introducing Tax features with the ability to configure Tax Rates and Ta
19
19
20
20
- Improved support for Stripe Error Codes when payment methods are invalid to map with our Transaction Response codes.
21
21
- 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.
22
-
- 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.
22
+
- 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.
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?v=4&size=40){kind=avatar}
0 commit comments