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

Is there documentation somewhere #28

Open
pinpox opened this issue Dec 18, 2021 · 8 comments
Open

Is there documentation somewhere #28

pinpox opened this issue Dec 18, 2021 · 8 comments

Comments

@pinpox
Copy link

pinpox commented Dec 18, 2021

I'd like to use this project but the documentation seems to be missing. The readme gives a bit of help, but not much.

  • How do I deploy an instance for productive use?
  • How do I customize the map or create my own?
  • Is video-chat between a large number of people supported, i.e. conference rooms?
  • How do I integrate things in the "functional rooms" as shown in the video, e.g. a whiteboard?

This project looks great and I would love to use it, but the lack of documentation is making it quite hard.

@kevinshen56714
Copy link
Owner

Hi @pinpox, thank you and sorry for the late reply. We have quite some plans for this project, and we're actively working on it! For example, very recently, we added whiteboards (#18) and custom room functionality (#29), which hopefully can address some of your comments.

Regarding the documentation, I think it's still early for us to focus on that because our codebase can be rapidly changing at this stage. However, we will be posting latest updates here on GitHub as well as on our new Twitter!

@pinpox
Copy link
Author

pinpox commented Jan 1, 2022

Thank you! I'll keep an eye on the project, looks promising. Adding docs would make it easier to contribute though.

@basilbowman
Copy link

@kevinshen56714 if you're available to chat with me, I'd gladly volunteer to write some docs (in exchange for not having to reverse engineer ALL of the map data format, for example )

@kevinshen56714
Copy link
Owner

@basilbowman sorry for my late reply. We are now working on migrating SkyOffice's site hosting from Heroku to Render. I will take some time to write some dev docs as well. Stay tuned!

@basilbowman
Copy link

Sure dude - mostly I meant I'd write up some Level 2 User docs - like, "here's how to get it running, here's how map formats work, stuff like that." I'm documenting as much as I can here: https://medium.com/@nathan.g.bowman/my-attempt-at-building-in-public-pt-1-2a7088325e6 - but I'd LOVE to chat with you for an hour or so instead :)

@namnm
Copy link

namnm commented Dec 28, 2022

Thank you for open source this great project.
Someone forked this repo into a product and put their webrtc service on sale https://gather.town/

@basilbowman
Copy link

Thank you for open source this great project. Someone forked this repo into a product and put their webrtc service on sale https://gather.town/

Lol - I was one of the first employees at Gather - SkyOffice is an OSS clone of Gather, not the other way around :)

@namnm
Copy link

namnm commented Dec 31, 2022

Oops thanks for your info.
I wonder there would be chance that if we use this open source repo then might get caught in a legal issue with Gather since these 2 are too similar, not mentioning source code but at least on the idea and appearance.

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

No branches or pull requests

4 participants