[Ai] Add support for serialization links #7297
Conversation
Dackka can generate links to code in other packages/sites, but has to be configured to do so. This change adds the necessary configuration so links to `kotlinx.serialization` code are correctly generated when processing refdocs.
![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 @rlazo, 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 enhances the documentation generation process by enabling Dackka to correctly create links to kotlinx.serialization code. It achieves this by adding a new package list file that outlines the serialization modules and configuring the Dackka generation task to recognize and link to the external kotlinx.serialization API documentation. This ensures that references to serialization components within the generated reference documentation are properly resolved and navigable.
Highlights
- Addition of
kotlinx.serializationpackage list: A new file,kotlindoc/package-lists/serialization/package-list, has been added. This file defines the modules and packages withinkotlinx.serialization, providing Dackka with the necessary information to correctly resolve and generate links to externalkotlinx.serializationdocumentation. - Configuration of Dackka for
kotlinx.serializationlinks: TheDackkaGenerationTask.ktfile has been updated to include a newpackageListUrlentry. This configuration links the 'serialization' key to the officialkotlinx.serializationAPI documentation URL, enabling Dackka to generate accurate cross-references to serialization code within the generated refdocs.
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 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. ↩
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. |
Generated by 🚫 Danger |
There was a problem hiding this comment.
Code Review
This pull request adds support for generating documentation links for kotlinx.serialization. The changes include adding a new package-list file for serialization and updating the Dackka configuration to include the external documentation link. The changes look good, but I have a suggestion to improve code maintainability and consistency in DackkaGenerationTask.kt.
| "firebase" to "https://firebase.google.com/docs/reference/kotlin/", | ||
| "coroutines" to "https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/", | ||
| "kotlin" to "https://kotlinlang.org/api/latest/jvm/stdlib/", | ||
| "serialization" to "https://kotlinlang.org/api/kotlinx.serialization", |
There was a problem hiding this comment.
To improve maintainability, it's good practice to keep map entries sorted alphabetically by key. This makes it easier to find entries and see what's available.
Additionally, for consistency with other kotlinlang.org URLs in this map, the URL for serialization should probably end with a trailing slash (/). While it might redirect correctly without it, being consistent can prevent potential issues with the documentation generation tool.
| "firebase" to "https://firebase.google.com/docs/reference/kotlin/", | |
| "coroutines" to "https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/", | |
| "kotlin" to "https://kotlinlang.org/api/latest/jvm/stdlib/", | |
| "serialization" to "https://kotlinlang.org/api/kotlinx.serialization", | |
| "coroutines" to "https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/", | |
| "firebase" to "https://firebase.google.com/docs/reference/kotlin/", | |
| "kotlin" to "https://kotlinlang.org/api/latest/jvm/stdlib/", | |
| "serialization" to "https://kotlinlang.org/api/kotlinx.serialization/", |
plugins test results67 tests 67 ✅ 2m 0s ⏱️ Results for commit 123e8b2. |
Size Report 1Affected ProductsNo changes between base commit (64b488f) and merge commit (c483254).Test Logs |
Coverage Report 1Affected Products
Test Logs |
Dackka can generate links to code in other packages/sites, but has to be configured to do so. This change adds the necessary configuration so links to
kotlinx.serializationcode are correctly generated when processing refdocs.Internal b/440622537