docs(documentation): Add API documentation links to package docs #461
Conversation
- Add pub.dev API links for: - avnu_provider - starknet - starknet_provider - secure_store - wallet_kit
|
To view this pull requests documentation preview, visit the following URL: docs.page/focustree/starknet.dart~461 Documentation is deployed and generated using docs.page. |
WalkthroughThis pull request updates several documentation files. In the README files, one package has removed a section header, while others have added links to API documentation. Additionally, multiple MDX documentation files have been updated to include API documentation links, ensuring users can easily access the relevant API reference pages. No functional changes or modifications to public entities have been made. Changes
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Hi, By "Link to API should be add in corresponding package documentation page." I was meaning that these links should be added to the corresponding package documentation on https://starknetdart.dev/ |
There was a problem hiding this comment.
Hi,
sorry but it seems that issue #460 description was not clear enough.
By "Link to API should be add in corresponding package documentation page." I was meaning that these links should be added to the corresponding package documentation on https://starknetdart.dev/
- Remove API documentation links from package READMEs: - avnu_provider - starknet - starknet_provider - secure_store - wallet_kit - Add API documentation links to corresponding docs pages: - docs/packages/avnu_provider.mdx - docs/packages/starknet.mdx - docs/packages/starknet-provider.mdx - docs/packages/secure-store.mdx - docs/packages/wallet-kit.mdx
|
@ptisserand Ready for review! 🚀 |
docs/packages/starknet.mdx
Outdated
| @@ -1 +1,2 @@ | |||
| # Starknet Package | |||
| 📚 [API Documentation](https://pub.dev/documentation/starknet_provider/latest/) | |||
There was a problem hiding this comment.
Wrong url, should be https://pub.dev/documentation/starknet/latest/
|
@ptisserand Addressed all review comments ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/packages/starknet-provider.mdx (1)
68-71: Usage Section Header Consistency
The "Usage" section ends with a subheading "### Call read-only method" (line 69), which seems inconsistent with the updated overall header "Starknet Provider." Consider revising or clarifying this subheading to ensure that the documentation's structure remains coherent.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/packages/starknet-provider.mdx(1 hunks)
🔇 Additional comments (7)
docs/packages/starknet-provider.mdx (7)
2-2: Verify Documentation Links
Both the API Documentation link (line 2) and Package Documentation link (line 8) are now clearly provided. Ensure that the URLs are current and accurate for user reference.Also applies to: 8-8
6-9: Clear Package Description
The updated description now clearly states the package’s purpose and includes a link to the official JSON-RPC specification along with package documentation. This improves clarity and aligns well with the overall documentation improvements.
10-17: Transaction Support Table is Clear and Well-Structured
The table outlining transaction support is formatted correctly and provides clear details on available features and their versions. No changes needed.
18-27: Informative Supported JSON RPC Methods Section
The introduction to the Supported JSON RPC methods (lines 18–27) is clear, and the inclusion of a command snippet to extract method names from the Starknet specifications will be helpful to developers.
28-53: Comprehensive Read Methods Table
The table listing read methods is detailed and well-organized, clearly indicating the implementation status for each method. Maintain consistency by updating statuses as future changes occur.
54-60: Well-Introduced Write Methods Section
The write methods section mirrors the structure of the read methods section, including an extraction command snippet, which aids in clarity and consistency.
61-67: Write Methods Table is Well-Formatted
The table detailing write methods is clear and easy to read. It effectively communicates which methods are implemented.
docs/packages/starknet-provider.mdx
Outdated
| # Call read-only method | ||
| 📚 [API Documentation](https://pub.dev/documentation/starknet_provider/latest/) | ||
| ======= | ||
| # Starknet Provider |
There was a problem hiding this comment.
Remove Conflict Markers & Clarify Header Update
The heading has been updated from "Call read-only method" to "Starknet Provider," which is appropriate given the broadened scope. However, the conflict resolution marker (=======) on line 3 should be removed to avoid unintended render artifacts in the final documentation.
-=======📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Call read-only method | |
| 📚 [API Documentation](https://pub.dev/documentation/starknet_provider/latest/) | |
| ======= | |
| # Starknet Provider | |
| # Call read-only method | |
| 📚 [API Documentation](https://pub.dev/documentation/starknet_provider/latest/) | |
| # Starknet Provider |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/packages/starknet-provider.mdx (3)
1-3: Consolidate and Clarify Header Titles
The file currently begins with an H1 header "# Call read-only method" on line 1 followed by another H1 header "# Starknet Provider" on line 3. This appears redundant and may confuse readers. It is recommended to remove or merge the headers so that there is one clear title for the page (for example, keeping only "# Starknet Provider").Suggested diff:
-# Call read-only method
2-7: Review Documentation Link Redundancy
Both an API documentation link (line 2) and a package documentation link (line 6) point to the same URL. Please verify if both links are needed. If they serve distinct purposes, consider adding clarifying text; otherwise, consolidating them could streamline the page.
66-69: Revise the Usage Section Header for Consistency
Within the "Usage" section, the subheading on line 67 reads "### Call read-only method". Given the overall focus on the Starknet Provider and the earlier header conflict, consider updating this subheading to better reflect the content (for example, changing it to "### Example Usage" or a similar term) or removing it if it is no longer applicable.Suggested diff:
-### Call read-only method +### Example Usage
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/packages/starknet-provider.mdx(1 hunks)
🔇 Additional comments (3)
docs/packages/starknet-provider.mdx (3)
8-15: Transaction Support Section Formatting
The "Transaction support" section is clearly presented with a markdown table. Please review the version numbers and implementation states to ensure they are up-to-date with the current features.
16-51: Accurate Reflection of Supported JSON RPC Methods
The "Supported JSON RPC methods" section, including both the read methods command snippet and the corresponding table, is well structured. Verify that the method statuses (✅/❌) accurately reflect the current implementation.
52-64: Clear Presentation of Write Methods
The "Write methods" section and its command code block are well formatted. Confirm that the extracted method names and their implemented statuses are correct as per the latest API updates.
docs/packages/starknet-provider.mdx
Outdated
| # Call read-only method | ||
| 📚 [API Documentation](https://pub.dev/documentation/starknet_provider/latest/) |
There was a problem hiding this comment.
I think these lines comes from a bad merge conflict resolution, could you please remove these lines
docs/packages/starknet-provider.mdx
Outdated
|
|
||
| ## Usage | ||
| ### Call read-only method | ||
|
|
There was a problem hiding this comment.
Please keep the call read-only snippet of code
packages/avnu_provider/README.md
Outdated
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Please remove these blank lines
| @@ -1,5 +1,4 @@ | |||
| # secure_store | |||
|
|
|||
There was a problem hiding this comment.
Please keep this blank line
…knet.dart into docs/add-api-links
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
packages/secure_store/README.md (4)
1-3: Improve clarity and grammar in the introductory description.
The current sentence:"The secure store is a Flutter allowing to securely store secret on a device, either using a password, or using biometrics."
could be rephrased for clarity and grammatical correctness—for example:
"Secure Store is a Flutter plugin that enables secure storage of secrets on a device using either a password or biometrics."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Possible missing article found.
Context: ...is a Flutter allowing to securely store secret on a device, either using a password, o...(AI_HYDRA_LEO_MISSING_A)
45-46: Refine usage instruction phrasing.
The phrase "Then you can use password store very easily:" could be simplified to avoid the overused intensifier. Consider revising to:"Then you can use the password store:"
🧰 Tools
🪛 LanguageTool
[style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... ```Then you can use password store very easily:
await PasswordStore().stor... (EN_WEAK_ADJECTIVE) </details> </details> --- `97-98`: **Refine phrasing for the Keychain Sharing note.** The note: > "NOTE: you only need to add the capability, it's not needed to add any Keychain Groups." could be rephrased for clarity and variety. For instance: > "NOTE: Only the Keychain Sharing capability needs to be added; adding Keychain Groups is not required." <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~98-~98: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ng-keychain-sharing). NOTE: you only need to add the capability, it's not needed to ... (REP_NEED_TO_VB) --- [style] ~98-~98: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ly need to add the capability, it's not needed to add any Keychain Groups. ## Security... (REP_NEED_TO_VB) </details> </details> --- `101-102`: **Improve grammar and accuracy in the Security Overview.** Please consider the following adjustments: - Replace "MacOS" with "macOS" for proper capitalization. - Update "if the device do not have a biometric component" to "if the device does not have a biometric component." - Rephrase "a password will be asked to encrypt data as a fallback method" to "the user will be prompted for a password to encrypt data as a fallback method." <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [grammar] ~102-~102: The operating system from Apple is written “macOS”. Context: ...ht be more secure than others. On iOS & MacOS, this plugin uses the [Secure Enclave](... (MAC_OS) --- [grammar] ~102-~102: “Device” is a singular noun. It appears that the verb form is incorrect. Context: ... protect the private key (if the device do not have a biometric component or not e... (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between ab0f215a67084136d232fce7305e89080151cee5 and 2d446fac9b87dd924f429ef5f3840783e344b875. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `docs/packages/starknet-provider.mdx` (1 hunks) * `packages/avnu_provider/README.md` (1 hunks) * `packages/secure_store/README.md` (1 hunks) </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary> * packages/avnu_provider/README.md </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>packages/secure_store/README.md</summary> [uncategorized] ~3-~3: Possible missing article found. Context: ...is a Flutter allowing to securely store secret on a device, either using a password, o... (AI_HYDRA_LEO_MISSING_A) --- [style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. Context: ... ``` Then you can use password store very easily: ```dart await PasswordStore().stor... (EN_WEAK_ADJECTIVE) --- [style] ~98-~98: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ng-keychain-sharing). NOTE: you only need to add the capability, it's not needed to ... (REP_NEED_TO_VB) --- [style] ~98-~98: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ly need to add the capability, it's not needed to add any Keychain Groups. ## Security... (REP_NEED_TO_VB) --- [grammar] ~102-~102: The operating system from Apple is written “macOS”. Context: ...ht be more secure than others. On iOS & MacOS, this plugin uses the [Secure Enclave](... (MAC_OS) --- [grammar] ~102-~102: “Device” is a singular noun. It appears that the verb form is incorrect. Context: ... protect the private key (if the device do not have a biometric component or not e... (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) </details> </details> </details> <details> <summary>🔇 Additional comments (6)</summary><blockquote> <details> <summary>docs/packages/starknet-provider.mdx (5)</summary> `1-6`: **Clear and Informative Header** The title, introductory description, and package documentation link are all clearly presented. This header effectively orients the reader about the purpose of the Starknet Provider document. --- `7-14`: **Well-Formatted Transaction Support Section** The "Transaction support" section, including the feature table (invoke, declare, deploy_account), is clear and well-organized. It provides a concise overview of supported features and their version history. --- `15-52`: **Organized Supported JSON RPC Methods Section** The section detailing "Supported JSON RPC methods" is neatly structured. The separation into a read methods section—with an embedded command snippet for extracting method names—and a subsequent table enhances usability and clarity. --- `53-66`: **Consistent Write Methods Section** The "Write methods" section mirrors the clarity of the previous parts. The command snippet and table are clear and maintain consistency with the overall document structure. --- `67-68`: _⚠️ Potential issue_ **Missing Usage Example in 'Call read-only method' Section** The header "### Call read-only method" is present; however, the corresponding usage example or code snippet has been removed. Previous feedback (e.g., ptisserand's comment) requested that the call read-only snippet be retained to aid users in practical implementation. Please confirm whether this removal was intentional due to a relocation of content to [starknetdart.dev] or if the snippet should be reinstated (or replaced with an alternative guidance) to avoid leaving the section effectively empty. </details> <details> <summary>packages/secure_store/README.md (1)</summary> `1-105`: **API Documentation Link Removal Verification.** Per the PR objectives, API documentation links belong on the dedicated documentation pages rather than in package READMEs. Please confirm that no API documentation links remain in this file. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~3-~3: Possible missing article found. Context: ...is a Flutter allowing to securely store secret on a device, either using a password, o... (AI_HYDRA_LEO_MISSING_A) --- [style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. Context: ... ``` Then you can use password store very easily: ```dart await PasswordStore().stor... (EN_WEAK_ADJECTIVE) --- [style] ~98-~98: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ng-keychain-sharing). NOTE: you only need to add the capability, it's not needed to ... (REP_NEED_TO_VB) --- [style] ~98-~98: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ly need to add the capability, it's not needed to add any Keychain Groups. ## Security... (REP_NEED_TO_VB) --- [grammar] ~102-~102: The operating system from Apple is written “macOS”. Context: ...ht be more secure than others. On iOS & MacOS, this plugin uses the [Secure Enclave](... (MAC_OS) --- [grammar] ~102-~102: “Device” is a singular noun. It appears that the verb form is incorrect. Context: ... protect the private key (if the device do not have a biometric component or not e... (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) </details> </details> </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
packages/secure_store/README.md
Outdated
| ```kt | ||
| package com.example.example | ||
|
|
||
| import io.flutter.embedding.android.FlutterActivity | ||
|
|
||
| class MainActivity: FlutterFragmentActivity() { | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Resolve import and class mismatch in the Android MainActivity snippet.
The snippet instructs to change MainActivity to extend FlutterFragmentActivity but still imports FlutterActivity. Please update the import to match the class extension. For example:
- import io.flutter.embedding.android.FlutterActivity
+ import io.flutter.embedding.android.FlutterFragmentActivity📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```kt | |
| package com.example.example | |
| import io.flutter.embedding.android.FlutterActivity | |
| class MainActivity: FlutterFragmentActivity() { | |
| } | |
| ``` |
There was a problem hiding this comment.
Please where do i add this import? import io.flutter.embedding.android.FlutterFragmentActivity
There was a problem hiding this comment.
@Cedarich You need to replace the existing import statement in the code snippet located in your README.md file. Here's the specific change needed:
package com.example.example
- import io.flutter.embedding.android.FlutterActivity
+ import io.flutter.embedding.android.FlutterFragmentActivity
class MainActivity: FlutterFragmentActivity() {
}This ensures that the import statement matches the class that MainActivity is extending. The inconsistency was that the code was importing FlutterActivity but extending FlutterFragmentActivity.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
packages/secure_store/README.md (4)
1-3: Improve introduction clarity.
The opening sentence is a bit awkward. Consider rephrasing it for clarity and grammatical correctness. For example:"The secure store is a Flutter plugin that allows secure storage of secrets on a device using either a password or biometrics."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Possible missing article found.
Context: ...is a Flutter allowing to securely store secret on a device, either using a password, o...(AI_HYDRA_LEO_MISSING_A)
45-45: Tone down intensifiers.
The phrase "use password store very easily:" could be simplified by removing "very" for a more neutral tone (e.g., "use password store easily:").🧰 Tools
🪛 LanguageTool
[style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... ```Then you can use password store very easily:
await PasswordStore().stor... (EN_WEAK_ADJECTIVE) </details> </details> --- `92-92`: **Refine phrasing in Mac setup note.** Consider rephrasing the note to avoid repetitive phrasing. For instance, you could update it to: > "NOTE: Only the capability needs to be added—adding Keychain Groups is not required." <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ng-keychain-sharing). NOTE: you only need to add the capability, it's not needed to ... (REP_NEED_TO_VB) --- [style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ly need to add the capability, it's not needed to add any Keychain Groups. ## Security... (REP_NEED_TO_VB) </details> </details> --- `96-97`: **Address grammatical issues in the security overview.** Please adjust the text for clarity and correctness: - Use "macOS" (not "MacOS") for proper branding. - Update the sentence to fix subject–verb agreement. For example: > "On iOS and macOS, this plugin uses the [Secure Enclave](https://support.apple.com/fr-ca/guide/security/sec59b0b31ff/web) to protect the private key. If a device does not have a biometric component or it is not enabled, a password will be requested to encrypt data as a fallback method." <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [grammar] ~96-~96: The operating system from Apple is written “macOS”. Context: ...ht be more secure than others. On iOS & MacOS, this plugin uses the [Secure Enclave](... (MAC_OS) --- [grammar] ~96-~96: “Device” is a singular noun. It appears that the verb form is incorrect. Context: ... protect the private key (if the device do not have a biometric component or not e... (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 2d446fac9b87dd924f429ef5f3840783e344b875 and 35330042553901b70f5fce8e47af8f5fe1c88693. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `packages/secure_store/README.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>packages/secure_store/README.md</summary> [uncategorized] ~3-~3: Possible missing article found. Context: ...is a Flutter allowing to securely store secret on a device, either using a password, o... (AI_HYDRA_LEO_MISSING_A) --- [style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. Context: ... ``` Then you can use password store very easily: ```dart await PasswordStore().stor... (EN_WEAK_ADJECTIVE) --- [style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ng-keychain-sharing). NOTE: you only need to add the capability, it's not needed to ... (REP_NEED_TO_VB) --- [style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ly need to add the capability, it's not needed to add any Keychain Groups. ## Security... (REP_NEED_TO_VB) --- [grammar] ~96-~96: The operating system from Apple is written “macOS”. Context: ...ht be more secure than others. On iOS & MacOS, this plugin uses the [Secure Enclave](... (MAC_OS) --- [grammar] ~96-~96: “Device” is a singular noun. It appears that the verb form is incorrect. Context: ... protect the private key (if the device do not have a biometric component or not e... (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) </details> </details> </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>packages/secure_store/README.md (2)</summary> `83-87`: **Verify Android MainActivity snippet placement.** The import statement for `FlutterFragmentActivity` and the class declaration are now aligned correctly. Please ensure this snippet is placed in the expected location to guide developers during Android platform setup. --- `1-99`: **Verify removal of API documentation references.** Since the primary objective of this PR is to relocate API documentation links from package READMEs to the dedicated documentation pages on starknetdart.dev, please confirm that no API documentation links remain in this file. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~3-~3: Possible missing article found. Context: ...is a Flutter allowing to securely store secret on a device, either using a password, o... (AI_HYDRA_LEO_MISSING_A) --- [style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. Context: ... ``` Then you can use password store very easily: ```dart await PasswordStore().stor... (EN_WEAK_ADJECTIVE) --- [style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ng-keychain-sharing). NOTE: you only need to add the capability, it's not needed to ... (REP_NEED_TO_VB) --- [style] ~92-~92: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ly need to add the capability, it's not needed to add any Keychain Groups. ## Security... (REP_NEED_TO_VB) --- [grammar] ~96-~96: The operating system from Apple is written “macOS”. Context: ...ht be more secure than others. On iOS & MacOS, this plugin uses the [Secure Enclave](... (MAC_OS) --- [grammar] ~96-~96: “Device” is a singular noun. It appears that the verb form is incorrect. Context: ... protect the private key (if the device do not have a biometric component or not e... (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT) </details> </details> </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Please keep original encoding.
There was a problem hiding this comment.
Please keep original encoding.
There was a problem hiding this comment.
Please keep original encoding.
There was a problem hiding this comment.
In your PR, you have changed line breaks from line feed to carriage return + line feed.
It must be reverted to original line breaks with line feed.
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/packages/starknet-provider.mdx (1)
66-67:⚠️ Potential issueIncomplete "Call read-only method" Section
The "### Call read-only method" section is currently empty. Previous review comments suggested retaining or providing the corresponding code snippet. Please either restore the omitted code snippet or remove/update the heading to avoid confusion.
♻️ Duplicate comments (1)
packages/wallet_kit/README.md (1)
1-1:⚠️ Potential issueHeader Mismatch: Verify Package Name Consistency.
The document title currently reads “# secure_store” even though this file is under the
wallet_kitpackage. Please confirm whether this header is intentional. If not, update it (for example, change to “# wallet_kit”) to avoid confusion.
Suggested change:-# secure_store +# wallet_kit
🧹 Nitpick comments (11)
packages/wallet_kit/README.md (11)
33-33: Spelling Adjustment: Use “information” Instead of “informations”.On line 33, replace “sensitive informations” with “sensitive information” (information is a non-count noun).
Suggested change:- (used to store/retrieve sensitive informations like Starknet private key for.) + (used to store/retrieve sensitive information like the Starknet private key.)🧰 Tools
🪛 LanguageTool
[misspelling] ~33-~33: The word ‘informations’ is a legal term. In standard English, the word ‘information’ is a non-count noun.
Context: ...aceID (used to store/retrieve sensitive informations like Starknet private key for.)(INFORMATIONS) </details> </details> --- `47-51`: **Stylistic Consistency: Revise MacOS Permissions Introduction.** The MacOS section begins with “Like iOS, you need to add some permissions.” Consider varying this phrasing to avoid repetition. For example, “Similarly to iOS, ensure that your MacOS setup includes the following permissions…” could improve the narrative flow. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~49-~49: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ing>MacOS
Like iOS, you need to add some permissions
- Keychain Shar...
(REP_NEED_TO_VB)
52-56: Stylistic Consistency: Rephrase Keychain Sharing Instructions.The instructions for adding Keychain Sharing could benefit from varied phrasing. For instance, instead of “You need to add the
Keychain Sharingcapability in the Xcode project [following this guide]…”, you might write: “Ensure your Xcode project is configured with Keychain Sharing by following [this guide]…”.🧰 Tools
🪛 LanguageTool
[style] ~53-~53: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ermissions
- Keychain Sharing
You need to add the
Keychain Sharingcapability i...(REP_NEED_TO_VB)
[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...-keychain-sharing).**NOTE: you only need to add the capability, it's not needed to ...
(REP_NEED_TO_VB)
[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ly need to add the capability, it's not needed to add anyKeychain Groups.**
- Camer...
(REP_NEED_TO_VB)
57-60: Stylistic Note: Clarify Camera Permission Instructions.The guidance on enabling Camera permission in the App Sandbox closely mirrors earlier platform instructions. Consider rewording for clarity and variety to maintain reader engagement.
🧰 Tools
🪛 LanguageTool
[style] ~59-~59: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Keychain Groups.**
- Camera
You need to enable
Camerapermission into App San...(REP_NEED_TO_VB)
128-128: Grammar Update: Correct “MacOS” and Verb Agreement.On line 128, change “MacOS” to “macOS” to align with Apple’s branding. Also, update “if the device do not have a biometric component” to “if the device does not have a biometric component.”
Suggested change:-On iOS & MacOS, this plugin uses the [Secure Enclave](...) to protect the private key (if the device do not have a biometric component or not enabled, a password will be asked...) +On iOS & macOS, this plugin uses the [Secure Enclave](...) to protect the private key (if the device does not have a biometric component or if it is not enabled, a password will be requested as a fallback...)🧰 Tools
🪛 LanguageTool
[grammar] ~128-~128: The operating system from Apple is written “macOS”.
Context: ...t be more secure than others.
On iOS & MacOS, this plugin uses the [Secure Enclave](...(MAC_OS)
[grammar] ~128-~128: “Device” is a singular noun. It appears that the verb form is incorrect.
Context: ... protect the private key (if the device do not have a biometric component or not e...(PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT)
286-286: Typographical Note: Validate Directory Path Notation.On line 286, the notation “../..” is used to indicate the project root when in
secure_store. Verify that this representation is intentional and clear, ensuring no unintended consecutive punctuation is present.🧰 Tools
🪛 LanguageTool
[typographical] ~286-~286: Two consecutive dots
Context: ...ou are insecure_store, this would be../...
Call this to start the devnet:``...
(DOUBLE_PUNCTUATION)
300-300: Sentence Structure: Adjust “however” Usage.The sentence beginning on line 300 uses “however” as a conjunction. Consider splitting the sentence or prepending a semicolon before “however” for improved clarity.
Example revision:-You are ready to create OpenZeppelin contracts, however you may need extra configuration if you want to run the example app. +You are ready to create OpenZeppelin contracts; however, you may need extra configuration if you want to run the example app.🧰 Tools
🪛 LanguageTool
[typographical] ~300-~300: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...e ready to create OpenZeppelin contracts, however you may need extra configuration if you...(HOWEVER_SENTENCE)
310-310: Punctuation Adjustment: Add Comma After “for example”.On line 310, insert a comma after “for example” to improve readability.
Suggested change:-For example with 192.168.1.15 as your host IP: +For example, with 192.168.1.15 as your host IP:🧰 Tools
🪛 LanguageTool
[typographical] ~310-~310: After the expression ‘for example’ a comma is usually used.
Context: ...ttp://YOUR_HOST_IP:5050/rpcFor example with 192.168.1.15 as your host IP: `... (COMMA_FOR_EXAMPLE) </details> </details> --- `370-370`: **Clarification: Define Default Behavior Clearly.** The sentence on line 370 could be clearer if revised to, “By default, the ETH balance is not rounded or truncated.” This slight modification enhances clarity. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~370-~370: Did you mean: “By default,”? Context: ... ``` ## Display formatted balance By default ETH balance was not rounded / truncated... (BY_DEFAULT_COMMA) </details> </details> --- `411-412`: **Typo Correction: Fix Pronoun Usage.** It appears there is a typo (“I you want to display the wallets list”) on lines 411–412. Please change “I you” to “If you” to correct the mistake. Suggested change: ```diff -I you want to display the wallets list, you just have to call this code: +If you want to display the wallets list, you just have to call this code:🧰 Tools
🪛 LanguageTool
[grammar] ~412-~412: Consider using only one pronoun here.
Context: ...6748692## Show wallets list I you want to display the wallets list, you j... (PRP_REPITION) </details> </details> --- `289-312`: **Markdown Lint: Specify Language Identifiers in Code Fences.** Several fenced code blocks (e.g., those starting around lines 289, 296, 306, 312, and 344) lack an explicit language identifier. Adding identifiers such as `yaml`, `dart`, `plist`, or `xml` will improve readability and syntax highlighting. Also applies to: 344-344 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [typographical] ~300-~300: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. Context: ...e ready to create OpenZeppelin contracts, however you may need extra configuration if you... (HOWEVER_SENTENCE) --- [typographical] ~310-~310: After the expression ‘for example’ a comma is usually used. Context: ...ttp://YOUR_HOST_IP:5050/rpcFor example with 192.168.1.15 as your host IP:
`...
(COMMA_FOR_EXAMPLE)
🪛 markdownlint-cli2 (0.17.2)
289-289: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
296-296: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
306-306: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
312-312: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/packages/starknet-provider.mdx(1 hunks)packages/wallet_kit/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/wallet_kit/README.md
[misspelling] ~33-~33: The word ‘informations’ is a legal term. In standard English, the word ‘information’ is a non-count noun.
Context: ...aceID (used to store/retrieve sensitive informations like Starknet private key for.)
(INFORMATIONS)
---
[style] ~49-~49: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ing>
MacOS
Like iOS, you need to add some permissions
- Keychain Shar...
(REP_NEED_TO_VB)
[style] ~53-~53: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ermissions
- Keychain Sharing
You need to add the Keychain Sharing capability i...
(REP_NEED_TO_VB)
[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...-keychain-sharing).
**NOTE: you only need to add the capability, it's not needed to ...
(REP_NEED_TO_VB)
[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ly need to add the capability, it's not needed to add any Keychain Groups.**
- Camer...
(REP_NEED_TO_VB)
[style] ~59-~59: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Keychain Groups.**
- Camera
You need to enable Camera permission into App San...
(REP_NEED_TO_VB)
[grammar] ~128-~128: The operating system from Apple is written “macOS”.
Context: ...t be more secure than others.
On iOS & MacOS, this plugin uses the [Secure Enclave](...
(MAC_OS)
[grammar] ~128-~128: “Device” is a singular noun. It appears that the verb form is incorrect.
Context: ... protect the private key (if the device do not have a biometric component or not e...
(PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT)
[typographical] ~286-~286: Two consecutive dots
Context: ...ou are in secure_store, this would be ../...
Call this to start the devnet:
``...
(DOUBLE_PUNCTUATION)
[typographical] ~300-~300: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...e ready to create OpenZeppelin contracts, however you may need extra configuration if you...
(HOWEVER_SENTENCE)
[typographical] ~310-~310: After the expression ‘for example’ a comma is usually used.
Context: ...ttp://YOUR_HOST_IP:5050/rpc
For example with 192.168.1.15 as your host IP:
`...
(COMMA_FOR_EXAMPLE)
---
[uncategorized] ~370-~370: Did you mean: “By default,”?
Context: ... ```
## Display formatted balance
By default ETH balance was not rounded / truncated...
(BY_DEFAULT_COMMA)
---
[grammar] ~412-~412: Consider using only one pronoun here.
Context: ...6748692
Show wallets list
I you want to display the wallets list, you j...
(PRP_REPITION)
🪛 markdownlint-cli2 (0.17.2)
packages/wallet_kit/README.md
115-115: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
119-119: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
123-123: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
289-289: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
296-296: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
306-306: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
312-312: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
344-344: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (10)
docs/packages/starknet-provider.mdx (8)
1-5: Verify API Documentation LinkThe
[Package documentation]link on line 4 currently points to "https://pub.dev/documentation/starknet_provider/latest/". However, the PR objective mentions moving API documentation references to their respective documentation pages on starknetdart.dev. Please confirm whether this link is intentional or if it should be updated to reflect the documentation site.
6-13: Transaction Support Section CheckThe "## Transaction support" section and its table are correctly formatted and maintain the required information for supported features.
14-17: Supported JSON RPC Methods HeaderThe header for "## Supported JSON RPC methods" and the version indication ("### Version: 0.7.1") are clearly stated and require no changes.
18-24: Read Methods SectionThe "### Read methods" section, along with the accompanying command snippet (using
jq) that extracts method names from the specification, is well presented. Please ensure the command snippet remains correct with future updates.
26-51: Read Methods Table VerificationThe Markdown table listing read methods and their implementation statuses is complete and clear. No modifications are necessary here.
52-58: Write Methods Section CheckThe "### Write methods" header and its associated command snippet (using
jq) are accurately rendered and maintain consistency with the "Read methods" section.
60-65: Write Methods Table VerificationThe table for write methods is correctly formatted and provides the required implementation details. Everything appears in order.
1-67: Ensure Consistent Line EndingsPrior feedback mentioned issues with line break encoding (CRLF vs. LF). Please verify that the document uses LF (line feed) as the line break to remain consistent with repository standards.
packages/wallet_kit/README.md (2)
2-2: Retain Blank Line Formatting.As previously noted by reviewers, please ensure this blank line remains intact to maintain consistent formatting.
1-466: Documentation Update Conformity.This README now omits any API documentation links, which aligns with the new documentation hierarchy—where such links are to be placed on starknetdart.dev. Please double-check that all API references have been fully migrated from package READMEs to their dedicated documentation pages.
🧰 Tools
🪛 LanguageTool
[misspelling] ~33-~33: The word ‘informations’ is a legal term. In standard English, the word ‘information’ is a non-count noun.
Context: ...aceID (used to store/retrieve sensitive informations like Starknet private key for.)(INFORMATIONS) --- [style] ~49-~49: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. Context: ...ing>MacOS
Like iOS, you need to add some permissions
- Keychain Shar...
(REP_NEED_TO_VB)
[style] ~53-~53: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ermissions
- Keychain Sharing
You need to add the
Keychain Sharingcapability i...(REP_NEED_TO_VB)
[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...-keychain-sharing).**NOTE: you only need to add the capability, it's not needed to ...
(REP_NEED_TO_VB)
[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ly need to add the capability, it's not needed to add anyKeychain Groups.**
- Camer...
(REP_NEED_TO_VB)
[style] ~59-~59: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Keychain Groups.**
- Camera
You need to enable
Camerapermission into App San...(REP_NEED_TO_VB)
[grammar] ~128-~128: The operating system from Apple is written “macOS”.
Context: ...t be more secure than others.
On iOS & MacOS, this plugin uses the [Secure Enclave](...(MAC_OS)
[grammar] ~128-~128: “Device” is a singular noun. It appears that the verb form is incorrect.
Context: ... protect the private key (if the device do not have a biometric component or not e...(PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT)
[typographical] ~286-~286: Two consecutive dots
Context: ...ou are insecure_store, this would be../...
Call this to start the devnet:``...
(DOUBLE_PUNCTUATION)
[typographical] ~300-~300: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...e ready to create OpenZeppelin contracts, however you may need extra configuration if you...(HOWEVER_SENTENCE)
[typographical] ~310-~310: After the expression ‘for example’ a comma is usually used.
Context: ...ttp://YOUR_HOST_IP:5050/rpcFor example with 192.168.1.15 as your host IP: `... (COMMA_FOR_EXAMPLE) --- [uncategorized] ~370-~370: Did you mean: “By default,”? Context: ... ``` ## Display formatted balance By default ETH balance was not rounded / truncated... (BY_DEFAULT_COMMA) --- [grammar] ~412-~412: Consider using only one pronoun here. Context: ...6748692Show wallets list
I you want to display the wallets list, you j...
(PRP_REPITION)
🪛 markdownlint-cli2 (0.17.2)
115-115: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
119-119: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
123-123: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
289-289: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
296-296: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
306-306: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
312-312: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
344-344: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
|
@ptisserand Thank you for your patience please review |
|
@ptisserand Thank you for your patience please review |
Description
This PR corrects the documentation links placement by moving API documentation references from package READMEs to their corresponding documentation pages on starknetdart.dev.
Changes
Removed API links from READMEs:
packages/avnu_provider/README.mdpackages/starknet/README.mdpackages/starknet_provider/README.mdpackages/secure_store/README.mdpackages/wallet_kit/README.mdAdded API links to documentation pages:
docs/packages/avnu_provider.mdx- Added below package descriptiondocs/packages/starknet.mdx- Added below titledocs/packages/starknet-provider.mdx- Added below titledocs/packages/secure-store.mdx- Added after introductory paragraphdocs/packages/wallet-kit.mdx- Added below titleNotes
Checklist
Summary by CodeRabbit