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

feat: expose kapi as part of docs #3996

Merged
merged 4 commits into from
Jun 23, 2023
Merged

feat: expose kapi as part of docs #3996

merged 4 commits into from
Jun 23, 2023

Conversation

ivarconr
Copy link
Member

@ivarconr ivarconr commented Jun 16, 2023

Small poc to add ask kapi.ai to our docs. UI not great yet.

image

And this is the widget in action:
image

@vercel
Copy link

vercel bot commented Jun 16, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 22, 2023 6:49am
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 22, 2023 6:49am

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is cool! Search doesn't seem to work in the preview though (just inifinite loading). Is that just because it's a preview or is there an issue somewhere?

image

Second, I don't think the unleash-api.info.mdx is part of this. Did you add that by mistake?

website/docs/reference/api/unleash/unleash-api.info.mdx Outdated Show resolved Hide resolved
@ivarconr
Copy link
Member Author

This is cool! Search doesn't seem to work in the preview though (just inifinite loading). Is that just because it's a preview or is there an issue somewhere?

jeah, that domain is not whitelisted on the kapi side.

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'm happy to get this in now 😄 I noticed that the response kapa gave you about Java still uses the no.finn. classes. I don't think that appears anywhere in our current docs (did a search now and didn't find it). Is that something we can help it sort out?

Copy link
Member

@nunogois nunogois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UI does look weird, should we wait until it gets fixed before enabling this?
But otherwise 👍

@ivarconr
Copy link
Member Author

UI does look weird, should we wait until it gets fixed before enabling this?

I think yes, but unsure of to fix it tbh.

@ivarconr
Copy link
Member Author

I noticed that the response kapa gave you about Java still uses the no.finn. classes. I don't think that appears anywhere in our current docs (did a search now and didn't find it). Is that something we can help it sort out?

Nice catch. I will ask them.

@ivarconr
Copy link
Member Author

UI does look weird, should we wait until it gets fixed before enabling this?

Yes it does. The Widget CSS is crashing with out CSS.

@Emil-Sorensen
Copy link

Hey Unleash team! Emil from kapa.ai here. :)

Trying replicating above. Looks like it's an odd case where the unleash custom figure component clashes with global styles which affects the kapa widget. We will try to get this fixed on our end by ensuring all styles are reset and unable to affect the component.

In case you are eager to deploy it now, I was able to get it working by commenting out one line in src/components/Figure/styles.module.css:

figure {
    box-shadow: var(--ifm-global-shadow-lw);
    border-radius: var(--ifm-global-radius);
    border: var(--ifm-global-border-width) solid var(--unleash-color-gray);
    /* padding: var(--ifm-pre-padding); */
    margin-inline: 0;
}

@thomasheartman
Copy link
Contributor

Ah, nice find! Thanks for having a look. We can adjust that on our end to only target figures within the main content, so that should work fine. Otherwise, a padding: unset on the kappa widget fixes it too.

Thanks!

@thomasheartman
Copy link
Contributor

Better?
image

@Emil-Sorensen
Copy link

Awesome Thomas - thanks for the tip with padding: unset - will deploy a bug fix shortly on the kapa-widget. :)

Otherwise LGTM. 👍

@ivarconr ivarconr merged commit 72657a6 into main Jun 23, 2023
10 of 16 checks passed
@ivarconr ivarconr deleted the feat/add-kapi-to-docs branch June 23, 2023 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants