Add a compatibility target to stories#4582
Conversation
Signed-off-by: Cristian Le <git@lecris.dev>
Summary of ChangesHello @LecrisUT, 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 addresses broken documentation links by implementing a compatibility layer within the Sphinx extension responsible for story rendering. By adding an alternative target format, the system can now correctly resolve both new and old link structures, ensuring that existing documentation references continue to work as expected without requiring manual updates to all external links. Highlights
Changelog
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request adds a compatibility target for story links to support older URL formats. The implementation is straightforward, but there's an edge case where the story name is just /, which could lead to an invalid empty ID for an HTML anchor. I've suggested a fix to handle this case by only adding the compatibility target if it's a non-empty string.
Signed-off-by: Cristian Le <git@lecris.dev>
|
Documentation-only, merging. |
Fixes the links that were pointing to pages as https://tmt.readthedocs.io/en/stable/spec/plans.html#spec-plans-provision-ansible
New format is https://tmt.readthedocs.io/en/stable/spec/plans.html#/spec/plans/provision/ansible