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

Migrate THEOlive docs #202

Merged
merged 22 commits into from
Feb 10, 2025
Merged

Migrate THEOlive docs #202

merged 22 commits into from
Feb 10, 2025

Conversation

dubeyShivank
Copy link
Contributor

@dubeyShivank dubeyShivank commented Feb 5, 2025

Migrated the Getting started section from https://developers.theo.live/docs/welcome over to GitHub/docusaurus.

Copy link
Contributor

github-actions bot commented Feb 5, 2025

PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-02-10 02:34 UTC

@jeroen-tempels
Copy link
Contributor

image
This page is not as intended, there are multiple items selected in the sidebar and the old and new explanation are just copied under each other which doesn't really make sense. Please fix the sidebar and clean up that content

@MattiasBuelens
Copy link
Collaborator

This page is not as intended, there are multiple items selected in the sidebar and the old and new explanation are just copied under each other which doesn't really make sense. Please fix the sidebar and clean up that content

That's happening because the index page appears twice in sidebarsTheolive.ts, first as its own sidebar item and then as the link of the Getting Started category. It should only appear at most once.

I would also prefer to have an proper "introduction" as landing page for THEOlive, separate from its "getting started" page. Usually, our introduction pages briefly describe the product, and then show an overview of all categories of that product's documentation. Have a look at the landing pages of THEOplayer and Open Video UI for some inspiration.

@jeroen-tempels
Copy link
Contributor

We're almost there, just want some tiny improvements to the main flow. Now the introduction page is about the player, and then in the getting started it is about the server. I think the introduction explain what the product is, and then in the getting started section there is a guide to setup the full thing with a dedicated player page.

@dubeyShivank
Copy link
Contributor Author

This page is not as intended, there are multiple items selected in the sidebar and the old and new explanation are just copied under each other which doesn't really make sense. Please fix the sidebar and clean up that content

That's happening because the index page appears twice in sidebarsTheolive.ts, first as its own sidebar item and then as the link of the Getting Started category. It should only appear at most once.

I would also prefer to have an proper "introduction" as landing page for THEOlive, separate from its "getting started" page. Usually, our introduction pages briefly describe the product, and then show an overview of all categories of that product's documentation. Have a look at the landing pages of THEOplayer and Open Video UI for some inspiration.

Yep - I reckon once the remaining sections from here are ported in, the player section will be adequately covered and with a more complete sidebar + card section on the intro page, it'll make more sense.

@dubeyShivank dubeyShivank merged commit b0a1bd5 into main Feb 10, 2025
2 checks passed
@MattiasBuelens MattiasBuelens deleted the theolive-migration branch February 10, 2025 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants