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

Better support for links in documentation #248

Open
tal-sapan opened this issue Jul 20, 2020 · 1 comment
Open

Better support for links in documentation #248

tal-sapan opened this issue Jul 20, 2020 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@tal-sapan
Copy link
Contributor

Some link text is not correctly rendered as links to the SAP UI5 documentation.
Examples:

  • Documentation links: topic:5ee619fc1370463ea674ee04b65ed83b should be rendered as https://sapui5.hana.ondemand.com/<version>/topic/5ee619fc1370463ea674ee04b65ed83b
  • Method names: #attachValidateFieldGroup should be rendered as https://sapui5.hana.ondemand.com/<version>/api/sap.ui.core.Control#methods/attachValidateFieldGroup
    • The logic for this should be to first check if the text is the name of a method, property, aggregation or event in the current context object (or its parents through inheritance) and create the link to the correct section accordingly. Note that only methods have direct links, the rest of the types can be linked to the corresponding section.
      Since we will need the context object for this check, we will have to send it to the documentation function.
@tal-sapan tal-sapan added enhancement New feature or request good first issue Good for newcomers labels Jul 20, 2020
@bd82 bd82 added the help wanted Extra attention is needed label Jul 20, 2020
@bd82
Copy link
Member

bd82 commented Jul 20, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants