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

Streamlining of "Admin API" wording #132

Closed
JOJ0 opened this issue Oct 13, 2023 · 2 comments
Closed

Streamlining of "Admin API" wording #132

JOJ0 opened this issue Oct 13, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JOJ0
Copy link
Owner

JOJ0 commented Oct 13, 2023

A low priority cosmetic thing:

We used to state "admin API" throughout.

Since AFAIK Synapse docs, at some point, have been changed to use "Admin API", we should streamline and use that wording/capitalization as well.

@JOJ0 JOJ0 added the documentation Improvements or additions to documentation label Oct 13, 2023
@JacksonChen666
Copy link
Collaborator

also, being more specific like "synapse admin API" is better than just "admin API" because the synapse admin API is specific to synapse and nothing else (dendrite, conduit, etc.)

@JOJ0
Copy link
Owner Author

JOJ0 commented Oct 14, 2023

In some places adding Synapse might be ok (and we often have that), in others leaving it out is the way to go because it's crystal clear already that we are talking about Synapse and repeating the word again doesnt help readability.

Mainly I'm talking about capitalization of the word Admin here anyway - it should be the same everywhere. When I started out writing this tool I tried to make sure I use lower case like Synapse docs used. That changed since then....they now start with a capital A.

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