Conversation
|
I have restructured the pages using bullet points + bold letters The design does not look particularly appealing to me. I also tested alternatives:
Let me know which of the options above you prefer. Feel free to suggest another option. |
MakisH
left a comment
MakisH
left a comment
There was a problem hiding this comment.
Thanks for the updates! Looks good overall.
I don't mind the boldface, but without would also be fine.
I would not use a blockquote (semantically different). I would also not use a table with one column, as shown in the alternatives.
I guess a table with a title column is not supported in Markdown / this Markdown flavor. But the current style is fine (for me) anyway.
| ## C++ Bindings | ||
|
|
||
| ## Bindings | ||
| Extensive documentation on the C++ API is available on [the preCICE API doxygen pages for the latest release](https://precice.org/doxygen/main/classprecice_1_1Participant.html), or [see more options](dev-docs-sourcedocs.html). |
There was a problem hiding this comment.
From what I understood from the discussion, we now want to remove the dev-docs-sourcedocs.html (and redirect from that to this page). This sentence can then include the rest of the options as well.
Ideally, I would make this another bullet point.
There was a problem hiding this comment.
Not sure what to do here. Here's my suggestion:
There was a problem hiding this comment.
I would add an additional bullet point for the develop, and I would list both the API and rest, as currently:
Co-authored-by: Gerasimos Chourdakis <gerasimos.chourdakis@ipvs.uni-stuttgart.de>
…ub.io into update-api-overview
2 participants
Fixes #715