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

Small issues with new API docs #1328

Open
TC-MO opened this issue Dec 9, 2024 · 4 comments
Open

Small issues with new API docs #1328

TC-MO opened this issue Dec 9, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation.

Comments

@TC-MO
Copy link
Contributor

TC-MO commented Dec 9, 2024

  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 TC-MO added the documentation Improvements or additions to documentation. label Dec 9, 2024
@TC-MO
Copy link
Contributor Author

TC-MO commented Dec 9, 2024

#3 addressed in #1331

@B4nan
Copy link
Member

B4nan commented Dec 11, 2024

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
Copy link
Member

B4nan commented Dec 11, 2024

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
Copy link
Member

B4nan commented Dec 11, 2024

Color of PUT requests between sidebar and main body is misaligned

This is resolved via #1344

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants