Skip to content

Commit e8705f4

Browse files
authored
Merge pull request #1 from GravityKit/feature/php-api
Include PHP API documentation for all items referenced in filters
2 parents b567121 + 1ded612 commit e8705f4

11 files changed

Lines changed: 3396 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ npm run repos:clone
3030
# Generate hooks documentation
3131
npm run hooks:generate
3232

33+
# Generate PHP API reference documentation (classes/functions)
34+
npm run api:generate
35+
3336
# Start local development server
3437
npm start
3538
```
@@ -77,6 +80,7 @@ gh auth login
7780
|---------|-------------|
7881
| `npm run repos:clone` | Clone/update all product repositories from GitHub |
7982
| `npm run hooks:generate` | Generate hooks documentation from cloned repos |
83+
| `npm run api:generate` | Generate PHP API reference docs (classes/functions) |
8084
| `npm run docs:full` | Full pipeline: clone repos, generate docs, build site |
8185
| `npm start` | Start local development server |
8286
| `npm run build` | Build static site for production |

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ const product_sitemaps_plugin = [
158158
},
159159
];
160160

161+
161162
/** @type {import('@docusaurus/types').Config} */
162163
const config = {
163164
title: 'GravityKit Developer Documentation',

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@
1616
"repos:clone": "node ./scripts/clone-repos.mjs",
1717
"repos:update": "node ./scripts/clone-repos.mjs",
1818
"hooks:generate": "node ./scripts/generate-hooks.mjs",
19-
"docs:generate": "npm run hooks:generate && node ./scripts/generate-category-indexes.mjs",
19+
"hooks:link-api-types": "node ./scripts/link-hooks-to-api.mjs",
20+
"api:generate": "node ./scripts/generate-php-api.mjs",
21+
"docs:generate": "npm run hooks:generate && npm run api:generate && npm run hooks:link-api-types && node ./scripts/generate-category-indexes.mjs",
2022
"llm:enhance": "node ./scripts/enhance-for-llms.mjs && node ./scripts/generate-product-llms.mjs",
2123
"llm:product": "node ./scripts/generate-product-llms.mjs",
2224
"docs:full": "npm run repos:clone && npm run docs:generate && npm run llm:enhance && npm run build"

0 commit comments

Comments
 (0)