Skip to content

feat(api-docs): Add an API docs page w/ Scalar#20

Draft
zachyale wants to merge 1 commit into
mainfrom
feature/add-api-docs
Draft

feat(api-docs): Add an API docs page w/ Scalar#20
zachyale wants to merge 1 commit into
mainfrom
feature/add-api-docs

Conversation

@zachyale
Copy link
Copy Markdown
Member

@zachyale zachyale commented May 5, 2026

Relevant Issue: #3

This PR adds the API docs to the grimmory.org site, by utilizing the docasaurus scalar plugin for easy embedding. It sources the openAPI json via the latest release.

I'm marking this as a draft until next release (or the JSON is updated), to more explicitly communicate to users that the API is highly experimental, and prone to change, and for more up to date info to consult the Discord for now.

image image

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2deb4fb9-a2dd-4139-8294-ae675e86d110

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/add-api-docs
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch feature/add-api-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@zachyale zachyale changed the title feat: add api docs via release artifact feat(api-docs): Add an API docs page w/ Scalar May 5, 2026
@zachyale zachyale requested a review from imnotjames May 5, 2026 21:13
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.

feat(api-docs): Add an API Reference Documentation page w/ Scalar

1 participant