Skip to content

Conversation

@stanlou
Copy link
Collaborator

@stanlou stanlou commented Nov 10, 2025

Description

This PR introduces a new CLI package to the framework that currently handles GraphQL documentation generation.
Additionally, a GitHub Actions workflow has been added to:

  • Use the CLI to generate GraphQL docs.
  • Automatically deploy the generated docs to GitHub Pages.

Changes Included

  • New CLI package under packages/cli.
  • GitHub Actions workflow for documentation generation and publishing.
  • Basic configuration for GraphQL docs generation.

Usage

You can use the new CLI both in the framework repository and the starter kit.

In the framework repository

Run the following command to start a fresh AppChain instance and generate GraphQL documentation:

npx @proto-kit/cli generate-gql-docs -e

Optionally, specify the GraphQL server port:

npx @proto-kit/cli generate-gql-docs -e -p 5050

In the starter kit

After installing the CLI package, you can generate the GraphQL documentation directly:

npx @proto-kit/cli generate-gql-docs

You can also specify a custom GraphQL endpoint:

npx @proto-kit/cli generate-gql-docs -u <graphql_url>

@stanlou stanlou self-assigned this Nov 10, 2025
@stanlou stanlou requested a review from rpanic November 10, 2025 17:15
@rpanic
Copy link
Member

rpanic commented Nov 14, 2025

@stanlou Lets fix the CI, then we're gtg

@rpanic rpanic merged commit 0125072 into develop Nov 18, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants