Skip to content

Raphael/client go #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raphael-istari wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Raphael/client go #723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25268d1
simplify client page and reference gitthub repo readme
raphael-istari Dec 12, 2025
ac5ed24
Update README.md
raphael-istari Dec 12, 2025
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
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ The built site will be in the `build/` directory. You can serve it locally with:
```bash
npm run serve
```
### Testing the current version
When testing locally you can set
```
includeCurrentVersion: true,
```
in the docs or graphql plugin in `docusaurus.config.ts`.

This will expose `next` in the version selector, so you can view the current (non versioned) documentation.

## Versioning

Expand All @@ -71,12 +79,16 @@ Docusaurus supports documentation versioning. Versioned documentation is stored
- `docs_versioned_sidebars/` - Versioned sidebar configurations
- `docs_versions.json` - Version metadata

The version dropdown in the navbar automatically detects which documentation section you're viewing and shows the appropriate versions. Currently, versioning is configured for the main `docs` section.
The version dropdown in the navbar automatically detects which documentation section you're viewing and shows the appropriate versions. Currently, versioning is configured for
- `docs` section
- `graphql` section

To create a new version:
1. Use the Docusaurus CLI: `npm run docusaurus docs:version <version>`
2. This creates a new version snapshot of the current docs



## Deployment

The documentation site is automatically deployed to CloudFlare:
Expand Down Expand Up @@ -129,6 +141,4 @@ docusaurus-docs/
```


## Runnable Code Examples

Some code examples in the documentation are interactive and runnable, allowing readers to execute queries directly in the browser. These are implemented using custom Docusaurus components.
Loading