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

Docs: Update community supported libraries in api doc #788

Merged
merged 6 commits into from
Aug 26, 2022

Conversation

ThePhar
Copy link
Member

@ThePhar ThePhar commented Jul 16, 2022

Wish markdown tables weren't horrible, but at least the output looks nice.

@ThePhar ThePhar changed the title Docs: Update client supported libraries in api doc Docs: Update community supported libraries in api doc Jul 16, 2022
Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a table is nice, but

  • right-aligning seems odd
  • SNI is a dependency (that is noted in multiple places) and does not have to be in this table
  • the meaning of / in c++ is ambiguous. I would prefer apclientpp<br/>apcpp
  • maybe a remarks column would be nice that says "CMake" for apcpp and "almost-header-only" for apclientpp since a major pain to integrating stuff into cpp is the build system.
  • maybe one row per lib/link would be cleaner than using <br/> at all?

@black-sliver black-sliver added the is: documentation Improvements or additions to documentation. label Jul 28, 2022
@ThePhar ThePhar requested a review from black-sliver August 22, 2022 22:16
@ThePhar
Copy link
Member Author

ThePhar commented Aug 22, 2022

How's something like this look?

@ThePhar ThePhar mentioned this pull request Aug 23, 2022
@ThePhar ThePhar merged commit a78863f into ArchipelagoMW:main Aug 26, 2022
@ThePhar ThePhar deleted the update-libs-in-docs branch August 26, 2022 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants