docs: update btc-assets-api API endpoints and deprecated links #10
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 @fghdotio, 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 focuses on enhancing the accuracy and currency of the project's documentation and code comments. It involves updating API endpoints, removing outdated instructions for access token acquisition, and migrating repository references to their new locations, ensuring that users and developers have access to the most up-to-date information.
Highlights
- Documentation Updates: The
README.mdfiles for the main repository and thepackages/servicedirectory have been updated to remove deprecated information and links, particularly concerning access token generation and old repository references. - API Endpoint Changes: A new testnet API endpoint
https://api-testnet.rgbpp.comhas been added to thepackages/service/README.md, and the contact email for mainnet access token requests has been updated. - Repository Link Migration: Multiple code comments across
packages/ckbfiles have been updated to reflect the migration of repository links fromckb-celltoRGBPlusPlusforunique-cellandrgbppprojects.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| 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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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 updates documentation across the repository, primarily to reflect changes in API endpoints and repository locations, and to remove deprecated information. The changes include updating URLs from the ckb-cell GitHub organization to RGBPlusPlus, refreshing API service endpoints, and removing a deprecated section about access tokens. While most updates improve clarity, there are a couple of inconsistencies in packages/service/README.md that could confuse users regarding the availability of the Signet service and the requirement for access tokens on testnet.
| - Signet: [/token/generate](https://api.signet.rgbpp.io/docs/static/index.html#/Token/post_token_generate) | ||
|
|
||
| As to the mainnet service, it's currently limited to verified apps only. When your app development is ready on testnet, and requires a mainnet access token, please email us at `f@cell.studio` to request a mainnet JWT token. In the email, please provide the following information about your app: | ||
| The testnet/signet services are currently public to access. As to the mainnet service, it's currently limited to verified apps only. When your app development is ready on testnet, and requires a mainnet access token, please email us at [buidl@rgbpp.com](mailto:buidl@rgbpp.com) to request a mainnet JWT token. In the email, please provide the following information about your app: |
There was a problem hiding this comment.
This change removes the section on how to get an access token for testnet/signet services, stating they are now 'public to access'. However, the code examples that follow (e.g., lines 52 and 62) still use BtcAssetsApi.fromToken, which requires an access token. This is contradictory and will likely confuse users.
If a token is no longer needed for testnet, please update the code examples to show the correct way to initialize the service. If a token is still required, please clarify how users can obtain one, as that information has been removed.
| - Signet: [/token/generate](https://api.signet.rgbpp.io/docs/static/index.html#/Token/post_token_generate) | ||
|
|
||
| As to the mainnet service, it's currently limited to verified apps only. When your app development is ready on testnet, and requires a mainnet access token, please email us at `f@cell.studio` to request a mainnet JWT token. In the email, please provide the following information about your app: | ||
| The testnet/signet services are currently public to access. As to the mainnet service, it's currently limited to verified apps only. When your app development is ready on testnet, and requires a mainnet access token, please email us at [buidl@rgbpp.com](mailto:buidl@rgbpp.com) to request a mainnet JWT token. In the email, please provide the following information about your app: |
There was a problem hiding this comment.
This sentence mentions that the Signet service is public to access, but the Signet service URL was removed from the list of endpoints above. This could be confusing for users. If the Signet service is deprecated, please remove the mention of 'signet' from this sentence. If it is still available, its URL should be added back to the list.
No description provided.