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

Make the docs embeddable #308

Open
kazk opened this issue Apr 21, 2021 · 2 comments
Open

Make the docs embeddable #308

kazk opened this issue Apr 21, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@kazk
Copy link
Member

kazk commented Apr 21, 2021

Replace outdated and unmaintained help tabs on Codewars.

When ?embedded=true, add html[data-embedded="true"] as early as possible, so we can style differently.

/* Hide navigation components when embedded. */
html[data-embedded="true"] {
  & .navbar,
  & .pagination-nav,
  & .footer,
  & div[class^="docSidebarContainer"],
  & div[class^="tableOfContents"] {
    display: none;
  }
}

(can also variant embedded and use embedded:hidden)

Also, allow overriding the theme with query parameter ?theme=dark|light to match the user's setting on Codewars. This should simply change html[data-theme].

@kazk kazk added the enhancement New feature or request label Apr 21, 2021
@kazk kazk self-assigned this Apr 21, 2021
@hobovsky
Copy link
Contributor

hobovsky commented May 6, 2021

BTW cold you provide places where "Help" tab is presented, what is its topic, and eventually what are the info tooltips there? Some of them might be outdated, but all of them present some kind of information which is needed to users, and it would be worthwhile to make sure that there's corresponding information in new docs. I think that many topics from help tabs are still not present in current docs, and there will be nothing to replace them with.

@kazk
Copy link
Member Author

kazk commented May 6, 2021

Kata editor:

image

image

Kumite editor:

image

We can add one in the trainer.


I can also show something to let users read the tutorial before creating a kata. Probably better to provide a link to open a new tab is better for this. There's only a brief tour of the kata editor at the moment.

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

No branches or pull requests

2 participants