@agenetix/docs 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -9
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Agenetix Docs
|
|
2
2
|
|
|
3
3
|
`@agenetix/docs` is an App Router-native MDX docs library for Next.js.
|
|
4
4
|
|
|
@@ -13,8 +13,8 @@ This repository contains both the published package and the example site that do
|
|
|
13
13
|
## Preview
|
|
14
14
|
|
|
15
15
|
<p align="center">
|
|
16
|
-
<img src=".github/assets/docs-page.png" alt="
|
|
17
|
-
<img src=".github/assets/theme-studio.png" alt="
|
|
16
|
+
<img src=".github/assets/docs-page.png" alt="Agenetix Docs docs page screenshot" width="49%" />
|
|
17
|
+
<img src=".github/assets/theme-studio.png" alt="Agenetix Docs theme studio screenshot" width="49%" />
|
|
18
18
|
</p>
|
|
19
19
|
|
|
20
20
|
The example site ships with a polished docs shell and an optional live theme studio for tuning presets, density, surface styles, and accent behavior.
|
|
@@ -157,7 +157,7 @@ Create `content/docs/getting-started/en.mdx`:
|
|
|
157
157
|
```mdx
|
|
158
158
|
---
|
|
159
159
|
title: "Getting Started"
|
|
160
|
-
description: "Your first
|
|
160
|
+
description: "Your first Agenetix Docs page"
|
|
161
161
|
order: 0
|
|
162
162
|
---
|
|
163
163
|
|
|
@@ -274,9 +274,17 @@ From `sqlos/web`, use a local file dependency:
|
|
|
274
274
|
|
|
275
275
|
The SqlOS repo also includes helper scripts to switch between a local file dependency and a published npm version.
|
|
276
276
|
|
|
277
|
-
##
|
|
277
|
+
## Publishing
|
|
278
278
|
|
|
279
|
-
-
|
|
280
|
-
|
|
281
|
-
-
|
|
282
|
-
-
|
|
279
|
+
`publish-npm.yml` is the only npm publish entry point. Merging to `main` does not publish `latest`.
|
|
280
|
+
|
|
281
|
+
- **Pull request against `main`** — publishes a preview dist-tag, for example `@agenetix/docs@pr-12`. The workflow comments with the exact package ref.
|
|
282
|
+
- **`v*` tag** (for example `v1.1.3`) — publishes `latest`. Bump `package.json` first; npm will not overwrite an already-published version.
|
|
283
|
+
|
|
284
|
+
To try a preview in a platform PR, add the ref to `infra/preview-packages.json`:
|
|
285
|
+
|
|
286
|
+
```json
|
|
287
|
+
{
|
|
288
|
+
"@agenetix/docs": "@agenetix/docs@pr-12"
|
|
289
|
+
}
|
|
290
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agenetix/docs",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"description": "App Router-native MDX documentation for Next.js with reusable layouts, search, TOC, and locale-aware routing.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
"saas",
|
|
64
64
|
"mcpstack"
|
|
65
65
|
],
|
|
66
|
-
"author": "
|
|
66
|
+
"author": "Agenetix <hello@agenetix.com>",
|
|
67
67
|
"license": "MIT",
|
|
68
68
|
"repository": {
|
|
69
69
|
"type": "git",
|