Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Impossible to put same link in body and see also with different title #480

Open
2 tasks done
a-docc-user opened this issue Feb 15, 2023 · 4 comments · May be fixed by #505 or swiftlang/swift-docc-render#691
Open
2 tasks done
Labels
bug Something isn't working enhancement Improvements or enhancements to existing functionality good first issue Good for newcomers

Comments

@a-docc-user
Copy link

Description

Markdown

For more information see the [specification](https://example.com).

## See Also
- [Full Name of the Specification](https://example.com)

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

Expected Result

For more information see the specification.

See Also

Actual behavior

Actual Result

For more information see the specification.

See Also

Steps To Reproduce

  1. Put following documentation:
For more information see the [specification](https://example.com).

## See Also
- [Full Name of the Specification](https://example.com)

Swift-DocC Version Information

Latest Xcode and also master

Swift Compiler Version Information

swift-driver version: 1.62.15 Apple Swift version 5.7.2 (swiftlang-5.7.2.135.5 clang-1400.0.29.51)
Target: arm64-apple-macosx13.0
@a-docc-user a-docc-user added the bug Something isn't working label Feb 15, 2023
@franklinsch
Copy link
Contributor

@Kyle-Ye would this be resolved as part of #376?

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Feb 15, 2023

Yes, I think this is a duplicate issue of #271.

@d-ronnqvist d-ronnqvist added the duplicate This issue or pull request already exists label Mar 1, 2023
@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Mar 12, 2023

Yes, I think this is a duplicate issue of #271.

[Update] After carefully reviewing it again, I found that it is a different issue. The current PR does not solve it.

The reason for this is that current seeAlsoSections implementation only store identifiers of link and then retrieve the title from the references using identifier matching.

"seeAlsoSections": [
    {
        "title": "Related Documentation",
        "identifiers": ["https://example.com", "https://example3.com"]
    }
]

To solve the problem, maybe we should update the seeAlsoSections implementation to store a overrideTitle here to support this feature.

@Kyle-Ye Kyle-Ye added good first issue Good for newcomers enhancement Improvements or enhancements to existing functionality and removed duplicate This issue or pull request already exists labels Mar 12, 2023
@Kyle-Ye Kyle-Ye linked a pull request Mar 12, 2023 that will close this issue
3 tasks
@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Mar 12, 2023

I just finish a draft implementation on this, any suggestion on this? @franklinsch

@mportiz08 mportiz08 linked a pull request Jun 9, 2023 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement Improvements or enhancements to existing functionality good first issue Good for newcomers
Projects
None yet
4 participants