Create troubleshooting-your-solution.md

[Blind4Basics]

This is a stub!

TODO:

• confirm the placement of the file in the directories tree => Need feeback about that

• correct/update the data at the top of the page => Need feeback about that (see on zulip too)

• images in light mode+dark mode to import/recreate

• all links to correct (directed to wiki for now) -> added TODO inside the tags of all the links to wiki to spot them more easily

I used the version available on the wiki on 23 Jul 2020.

[Blind4Basics]

damn it... x/

the linter rejects built in in the text while the sentences are correct: the tests are built in such a way... => how to bypass the linter in this kind of case?

[kazk]

You can use textlint-disable/textlint-enable comments. Or update the rule in .textlintc.js.

[kazk]

I don't know why it's not working :(

[kazk]

confirm the placement of the file in the directories tree => Need feeback about that

Putting this under /recipes is correct, but we'll split this up and make this an introduction page for all the troubleshooting solution recipes.

[Blind4Basics]

there are problems with internal links ([...](#internal-link)). Not sure if it's related to the preview of the PR if it will show up in the merged version too, but here is the thing:

in preview mode:

• when clicking on the link, nothing happens
• when opening the same link in a new tab, that "works" -> I get a new tab pointing on the related section, but the title is hidden behind the search bar:

Clicking on My solution seems to work fine, but some tests fail, the title is My solution works on my machine, but not on Codewars, OR My solution seems correct, but some tests fail when I attempt >>>IT.<<< -> only the "it" is showing up.

Is it sepcific to the preview? (I guess not...)

[Blind4Basics]

aside of the link troubles (see above), ready to merge, it seems

[kazk]

The header being hidden or only partially showing is a bug. The browser is scrolling to the point where the header is at the top of the page, but the search bar is blocking it. I'll look into that.

Can you remove the Table of Contents? It's now generated on the side.

Also, you don't need to do it in this PR, but we should reorganize the sections so it's more clear what each are about, then later split into separate pages.

[Blind4Basics]

The header being hidden or only partially showing is a bug. The browser is scrolling to the point where the header is at the top of the page, but the search bar is blocking it. I'll look into that.

Don't forget to look at the fact that the anchors do not work when simply left-clicking on them (staying in the same page, so. Note: I didn't check with anything else than firefox, tho)

Can you remove the Table of Contents? It's now generated on the side.

done.

...but I guess we'll need shorter titles... XD

[hobovsky]

Can you remove the Table of Contents? It's now generated on the side.

To be honest, I liked TOC at the top more than side navigation. My idea behind the troubleshooting FAQ was to make it, well, a troubleshooting FAQ: user comes with some specific problem, searches for statement of that problem in a list of frequently encountered problems, and it leads them to the answer. I think that sidebar is meant more for navigation rather than being used as a kind of index, and it won't work well in case of this type of pages.

At the moment, I have no good idea how to make the FAQ look better, but IMO removing list of questions at the top and leaving a side menu does not help much.

[kazk]

Yeah, we can create a page for that after splitting this up.

[kazk]

I think it's best to have a single problem per page and those can link to each other as necessary. We can have an index page too, but I don't want everything on the same page.

Each of these page should have some consistent format like:

# How to ...

explain the problem

## Answers

can link to other pages

## Further Reading

The sidebar can be populated with related pages based on topics or snippets in different languages.

---

As I said before, we can pretty much tweak anything so feel free to open issues about any ideas you have.

I'm thinking of showing these pages automatically when a user tries to comment on Codewars containing specific keywords. To make that work, we should have stable URL for each problem instead of anchors within a page.