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

Add online API reference site (e.g. Dokka) #2228

Open
aSemy opened this issue Mar 16, 2024 · 4 comments
Open

Add online API reference site (e.g. Dokka) #2228

aSemy opened this issue Mar 16, 2024 · 4 comments

Comments

@aSemy
Copy link
Contributor

aSemy commented Mar 16, 2024

Is your feature request related to a problem? Please describe.

I want to be able to look and search through at the available classes and functions on an easily accessible website.

I want to be able to create 'external links' in my own Dokka websites

Describe the solution you'd like

Create a Dokka HTML website.

Host the API reference documentation on GitHub Pages.

Describe alternatives you've considered

Searching the source code through GitHub (although this is not easy, and isn't pretty. It's also hard to link to. It doesn't work for external Dokka links).

Additional context

I see that the Gradle build config for this project is well structured and follows Gradle best practices. The official Dokka Gradle Plugin would unfortunately break this. Instead, I'd be happy to create a PR that would add Dokkatoo, which would be compatible.

@turansky
Copy link
Collaborator

turansky commented May 26, 2024

Host the API reference documentation on GitHub Pages.

Links to original documentations? :)

@aSemy
Copy link
Contributor Author

aSemy commented May 26, 2024

Host the API reference documentation on GitHub Pages.

Links to original documentations? :)

Sorry, I don't understand, could you elaborate?

@turansky
Copy link
Collaborator

Which "API reference documentation" you want to collect?
In common case original (JS documentation) is what required for user

@aSemy
Copy link
Contributor Author

aSemy commented May 26, 2024

Ahh I see! Well, if the Kotlin docs have the JS docs, then it will be displayed.

For example, properties in AccordionProps are documented:

image

But you want to see a link to the original JS library documentation? E.g. a link to https://mui.com/material-ui/api/accordion/#props. That sounds like something that the JS-to-Kotlin generator should do. But I don't think there's a standard way of getting a link to the docs... it might need to be configured per library?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants