Dev Doc improvement

[HawkXP71 118]

The current root page of the dev documentation should have a "Plugin C# API" and "Server C# API" in its "Emby SDK" TOC on the left hand side.

Right now, to find either API, you have to realized its under the developer home (not obvious), then find the "worth a look" link in the "Emby Server .NET API" group.

It would be great if there was a quick link at the top to get to the "Documentation/reference/index.html" page

Scott

[Luke 42989]

@softworkz

[softworkz 5368]

2 hours ago, HawkXP71 said:

The current root page of the dev documentation should have a "Plugin C# API" and "Server C# API" in its "Emby SDK" TOC on the left hand side.

Right now, to find either API, you have to realized its under the developer home (not obvious), then find the "worth a look" link in the "Emby Server .NET API" group.

It would be great if there was a quick link at the top to get to the "Documentation/reference/index.html" page

Scott

 

Hi Scott,

thanks for the suggestion! We are welcoming suggestions as there's always room for improvements and we don't want to miss any opportunity for getting better.

Yet, in this case, I'm not quite sure what you're up to, because there's nothing like two different C# APis:

• There's a .NET API for developing server plugins (C# is  .net language of course)
• And there's a REST API for accessing Emby Server via  a remote connection
  For that REST API access, we are providing a range of ready-made implementations in various programming languages - including C#,
  but that's not a C# API, these are just REST API clients we provide for various languages

[HawkXP71 118]

On 8/27/2026 at 3:21 PM, softworkz said:

 

Hi Scott,

thanks for the suggestion! We are welcoming suggestions as there's always room for improvements and we don't want to miss any opportunity for getting better.

Yet, in this case, I'm not quite sure what you're up to, because there's nothing like two different C# APis:

• There's a .NET API for developing server plugins (C# is  .net language of course)
• And there's a REST API for accessing Emby Server via  a remote connection
  For that REST API access, we are providing a range of ready-made implementations in various programming languages - including C#,
  but that's not a C# API, these are just REST API clients we provide for various languages

Sorry if I was confusing

 

My goal? I want to be able to get to the server side C# api documentation as soon as possible. Not the REST api

I was hoping it could be added to the tree explicitly on the LHS

[softworkz 5368]

41 minutes ago, HawkXP71 said:

My goal? I want to be able to get to the server side C# api documentation as soon as possible. Not the REST api

I was hoping it could be added to the tree explicitly on the LHS

It's already there.

When you click on REFERENCE at the top, you get two choices in the TOC: https://betadev.emby.media/reference/index.html

 

[HawkXP71 118]

I see the confusion, Im taling the Emby.SDK/Documentation/index.html

 

 

The home page for emby dev documenation, should have a one click way to go to the C# api, just as it does the REST API Clients

 

[softworkz 5368]

Not sure what you mean, to me it looks like the two are treated equally:

Edited 1 hour ago by softworkz

[HawkXP71 118]

Right now, from the root index.html I have to do the following (and remember, I dont work on this every day ), so Im doing this.

Open index.html

Click the emby SDK on the left hand side tree. 

Realize that was the wrong page..

Then I have to read the first block in "Whats new?" and find the Just take a look and see link,

nope wrong again

Then finally ill remember to find the "worth a look" and click that.

Im simply saying, in the menu tree
Emby SDK
| - Emby Server .NET API
| - Emby Server Rest API
    | - Rest API Clients
    | - Plugin Sample Code

Would make finding the C# server api much easier

 

 

[softworkz 5368]

Okay, now I got what you mean.

The point is that there are 4 separate TOCs - they are separate for a reason: The reference tocs are just gigantic and not really handy for browsing and even recognizing conceptual documentation topics from reference documentation pages.

I agree that the whole entry to the site can be improved in a number of ways and we'll surely do at some point, but I also believe that we have the best and most comprehensive developer documentation in the competition and all you have to remember for now is to click "REFERENCE" to get exactly to the TOC tree you're indicating...

Thanks a lot for your feedback. It won't get acted upon immediately, but be assured that it will be remembered once we'll be working on it again.