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

Wiki needs updated #245

Closed
cewert opened this issue Apr 2, 2025 · 7 comments
Closed

Wiki needs updated #245

cewert opened this issue Apr 2, 2025 · 7 comments
Labels
bug Something isn't working

Comments

@cewert
Copy link
Member

cewert commented Apr 2, 2025

There are still a couple references to viv in the wiki that need updated but, more importantly, are we allowed to have a wiki now???

We asked for years to have a wiki on our repo and were told no every time. That if we wanted to have docs for the client they needed to be hosted on the jellyfin website. So did the wiki go unnoticed and slip through or are we allowed to build out a wiki now? If the wiki is allowed then it would be nice to have confirmation before people start making PRs to add to it and if it's not allowed then we should make an issue to fix it 👍

@cewert cewert added the bug Something isn't working label Apr 2, 2025
@jimdogx
Copy link
Collaborator

jimdogx commented Apr 2, 2025

Thanks. I've updated the Wiki. The content here is specific to developing against the Jellyfin Roku app and not general documentation around installing, setup, using, etc. 👍

@jimdogx jimdogx closed this as completed Apr 2, 2025
@cewert
Copy link
Member Author

cewert commented Apr 3, 2025

You missed the viv reference on the wiki homepage.

It's client documentation which I was told had to be hosted on the website. Are you saying this was approved by leadership or not? What exactly is allowed and what isn't?

Why would a roku dev need to understand how deep linking works to write code for us? Isn't deep linking more of an advanced feature for power users who want to setup automations?

@cewert
Copy link
Member Author

cewert commented Apr 3, 2025

782030 - is the channel ID for Jellyfin. Without it, the Roku device does not know which channel to launch.

I don't recall what our app id is but I assume this is wrong because it's still the same value from when the wiki was first setup on viv.

@cewert
Copy link
Member Author

cewert commented Apr 3, 2025

Why can't we just add the deep linking stuff to the dev docs we already have?

@joshuaboniface
Copy link
Member

It's client documentation which I was told had to be hosted on the website. Are you saying this was approved by leadership or not? What exactly is allowed and what isn't?

What I know we've said in the past is that we prefer client documentation to be on the website because then users can find it all in one central place. But this repo is less than 2 weeks old and things will take time to move and reorganize. Developer documentation does belong in the repo until the development docs site is ready, but whether that's in a Wiki or committed file is up to the repo owners.

@cewert
Copy link
Member Author

cewert commented Apr 3, 2025

Multiple people from the roku team have brought up having a wiki over the years and we were told no. We didn't have ownership of the repo at that time which is why we had to ask you guys to enable it for us but you said no. I'm not stressing about any of that though. Just confused about the current state of the new repo. There's been a ton of things changed so it's hard to keep up 😄

@joshuaboniface
Copy link
Member

joshuaboniface commented Apr 3, 2025

In that case let's consider the policy changed :) I personally have no issue with Wikis and in fact think they might be better than committed docs for a lot of things (developer-docs wise), maybe it was me who didn't like them in the past I don't recall any longer, but going forward I think this sort of setup is fine (and is mirrored by the Vue and Swiftfin, which are both similar out-of-org-adopted repos).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants