nhovratov / jobfair

5 stars 4 forks source link

Doc cleanup #17

Closed ineswillenbrock closed 1 year ago

ineswillenbrock commented 1 year ago

I cleaned the languages in the code markup in FAQ/Index.rst to meet the guidelines. Should I add the captions with the filenames, too?

nhovratov commented 1 year ago

Ah, cool thank you!

Should I add the captions with the filenames, too?

That would be the cherry on the cake. Do it, if you want :)

ineswillenbrock commented 1 year ago

wait... sth went wrong with the markup

ineswillenbrock commented 1 year ago

no captions - but also no typos. I'd have to investigate other extensions if its github or me...

ineswillenbrock commented 1 year ago

We've got a slight problem with the captions: I can add them but we'll loose the corresponding code blocks on github. I investigated some other extensions and those, that have every code block visible on github don't use captions. Those that do use them loose the visibility of these code blocks on github when previewing the documentation. On the one hand it might be great to have the captions in the official docs, on the other hand there might be those, that try to use the docs on github. Any preferences?

nhovratov commented 1 year ago

Stick with the captions. The official documentation is rendered on docs.typo3.org and all links are targeting that resource. If something doesn't work on GitHub it doesn't matter much.

ineswillenbrock commented 1 year ago

Please have a look if that's good.

nhovratov commented 1 year ago

Thank you very much!