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

API Docs: shows method and content type in toc instead of generic icon #1263

Merged
merged 1 commit into from
Jul 28, 2023

Conversation

cschierle
Copy link

Provides a better overview of the service capabilities in the table of contents. Also eliminates name conflicts if documentation exists for the same service with different content types (e.g. json vs xml as in the 2nd screenshot).

Before:
Bildschirmfoto 2023-07-27 um 12 11 19
Bildschirmfoto 2023-07-27 um 12 10 54

After:
Bildschirmfoto 2023-07-27 um 12 17 43

Bildschirmfoto 2023-07-27 um 12 16 53

@cschierle cschierle added the 🧬 Enhancement Contains new features label Jul 27, 2023
@cschierle cschierle changed the title Replaces icon with service type and format tag API Docs: shows method and content type in toc instead of generic icon Jul 27, 2023
Copy link
Member

@jakobvogel jakobvogel left a comment

Choose a reason for hiding this comment

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

Hmm, not sure whether everybody agrees in terms of alignment in the table of contents

@cschierle
Copy link
Author

Hmm, not sure whether everybody agrees in terms of alignment in the table of contents

True, I'm also not 100% happy with the alignment. But it also not easy to optimize this with navboxLinks.

In my opinion, displaying the tags brings more benefit than perfect alignment though 🤷

Copy link
Member

@sabieber sabieber left a comment

Choose a reason for hiding this comment

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

Maybe we can optimize it further. I like the suggested change 👍🏻

@sabieber sabieber merged commit bee1586 into develop Jul 28, 2023
@sabieber sabieber deleted the feature/csc/serviceTags branch July 28, 2023 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧬 Enhancement Contains new features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants