feat: api documentation #603
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @auricom, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the project's documentation by introducing a dedicated and dynamically generated API reference section. It integrates a new VitePress plugin to consume an OpenAPI specification, providing comprehensive and easily navigable documentation for the Rollkit API's various services and endpoints.
Highlights
- API Documentation Integration: I've integrated the
vitepress-openapiplugin to automatically generate API documentation pages from an OpenAPI specification, enhancing the site's ability to provide up-to-date API references. - Comprehensive OpenAPI Specification: A detailed OpenAPI 3.1.0 specification for the Rollkit API has been added, covering Signer, Store, P2P, and Health services with their respective endpoints, request/response schemas, and examples.
- Dynamic Navigation and Content Generation: The site's navigation and content are now dynamically generated for the API documentation, ensuring that new API operations are automatically reflected in the sidebar and have dedicated pages.
- Dependency Updates and Cleanup: The
package.jsonandyarn.lockfiles have been updated to include the newvitepress-openapidependency and its transitive requirements, while also removing some previously used external analytics/chat scripts.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces API documentation generated from an OpenAPI specification using vitepress-openapi. The changes include adding the new dependency and configuring it in VitePress. A critical issue was identified where a sidebar configuration was incorrectly placed, overwriting analytics scripts. Improvements were also suggested for code formatting and page titles.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Overview
Documentating RPC endpoints using vitepress-openapi.
The
src/openapi-rpc.jsonfile will need to be updated following the rollkit lifecycle, so that documentation can be up-to-date.