Skip to content

Restructure API page#718

Open
carme-hp wants to merge 16 commits intomasterfrom
update-api-overview
Open

Restructure API page#718
carme-hp wants to merge 16 commits intomasterfrom
update-api-overview

Conversation

@carme-hp
Copy link
Member

Fixes #715

@carme-hp carme-hp requested a review from MakisH February 17, 2026 17:23
@carme-hp
Copy link
Member Author

I have restructured the pages using bullet points + bold letters
image

The design does not look particularly appealing to me. I also tested alternatives:

  • bullet points (not bold)
image
  • blockquote
image
  • table
image
  • table (not bold)
image

Let me know which of the options above you prefer. Feel free to suggest another option.

Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

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.

@MakisH MakisH added the content Content-only issues label Feb 22, 2026
@MakisH
Copy link
Member

MakisH commented Mar 14, 2026

I applied a few more changes directly:

  • Added links to various pages of api.precice.org, for main and develop.
  • Removed the source documentation page, added a redirect to the API page, and updated URLs.
  • Added usage examples, as motivated in Update the C++ API location / URLs #836.
  • For sections where usage was not trivial, or there is no source documentation, I skipped the respective field.

The page now looks like this:

Screenshot from 2026-03-14 17-38-16

@fsimonis any further suggestions?

Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

From my side, this is ready. Maybe @fsimonis has more points here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Content-only issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Structure of the API overview page, relation to source documentation

2 participants