apify-docs icon indicating copy to clipboard operation
apify-docs copied to clipboard

Small issues with new API docs

Open TC-MO opened this issue 1 year ago • 6 comments

  1. We are missing syntax highlighting for code examples
  2. We have inconsistencies with table headers throughout docs, sometimes they are lowercase, sometimes capitalized|

image image

  1. Actors throughout prose & endpoint names is not capitalized

image

4.We have some comments left in the spec

image

  1. Typo in Authentication section

image

  1. Color of PUT requests between sidebar and main body is misaligned

image

TC-MO avatar Dec 09 '24 19:12 TC-MO

#3 addressed in https://github.com/apify/apify-docs/pull/1331

TC-MO avatar Dec 09 '24 20:12 TC-MO

We are missing syntax highlighting for code examples

This is not 100% correct, we are missing just a few of the languages like C or Ruby. connected to the question of what we want to have in there. having more languages supported means a bigger CSS bundle. i would be in favor of removing some like R, Ruby or OCaml. I'll enable C, Java and a few more now

B4nan avatar Dec 11 '24 16:12 B4nan

4.We have some comments left in the spec

I believe this is on purpose, to let the writer know that the number needs to be in sync with some constant. The problem is that redoc treats this as HTML but the new plugin wont respect such comments. I am not sure if we want to get rid of them, we should rather find a way to make them not rendered (which should be most likely a markdown syntax comments, I'll test it out if it works with redoc too).

B4nan avatar Dec 11 '24 16:12 B4nan

Color of PUT requests between sidebar and main body is misaligned

This is resolved via #1344

B4nan avatar Dec 11 '24 16:12 B4nan

4.We have some comments left in the spec

This is resolved via #1371

Typo in Authentication section

This as well

B4nan avatar Jan 03 '25 10:01 B4nan

once #1371 is merged, only 2. and 3. are valid from this issue

B4nan avatar Jan 03 '25 16:01 B4nan