SkyOffice icon indicating copy to clipboard operation
SkyOffice copied to clipboard

Is there documentation somewhere

Open pinpox opened this issue 2 years ago • 8 comments

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.

pinpox avatar Dec 18 '21 10:12 pinpox

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!

kevinshen56714 avatar Jan 01 '22 21:01 kevinshen56714

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

pinpox avatar Jan 01 '22 22:01 pinpox

@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 )

basilbowman avatar Nov 16 '22 19:11 basilbowman

@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!

kevinshen56714 avatar Nov 27 '22 21:11 kevinshen56714

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 :)

basilbowman avatar Dec 01 '22 17:12 basilbowman

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/

namnm avatar Dec 28 '22 18:12 namnm

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 :)

basilbowman avatar Dec 31 '22 00:12 basilbowman

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.

namnm avatar Dec 31 '22 03:12 namnm