rojo.space icon indicating copy to clipboard operation
rojo.space copied to clipboard

chore list for docs

Open Barocena opened this issue 2 years ago • 2 comments
trafficstars

I decided to make a big list of suggestions and changes needed

  • Rojo docs needed changes
    • Main Page
      • I dont think we need the "games using rojo" anymore (it is popular and known enough and not worth getting issues for "add x game") ❌
      • ~~New Maintainers Page (#106)~~
    • Introduction Page
      • we can recommend luau-lsp in the Tools section
      • we can add a new video about rojo, from connect 2023 event (https://www.youtube.com/watch?v=oaaAf3_5S7g)
      • extensions under the External Text editors section is outdated
    • Help Page
      • help page can be merged with introduction
    • Gettings Started Page
      • ~~Aftman for install guide (#112)~~
      • encouraging lune over remodel and maybe rbxlx-to-rojo tool made with lune if it is possible
    • Project Format Page
      • document optional path feature
    • Properties Page
      • ~~Document Font Type (#99) (and other implicit format changes that we discussed)~~
    • Sync Details Page
      • we can have better images for explaining init.lua behaviour (with photos from both filesystem and roblox explorer)
      • we can add a warning in to the Limitations section about why some properties cannot be rojo served but only rojo build (pluginsecurity stuff)
      • Meta file example with actors (since people ask about it a lot )
    • Recommended Workflows Page
      • detailed explanation / guide for fully managed and the differences between fully and partially managed workflows
    • Rojo Alternatives Page
      • all the "rojo alternatives" are pretty much old and outdated, we dont need to recommend those
    • Upgrading From Rojo 6 Page
      • this page can be renamed to Migration from old versions and sectioned out for each version to easily read multiple version migration on the same page (instead of changing to old version of doc for each version migration)

Barocena avatar Jul 20 '23 00:07 Barocena

I'm not sure about removing the "games using rojo" section (if someone is new to the 3rd party ecosystem I think it serves as a good endorsement) but the rest of this seems like a good plan.

Dekkonot avatar Jul 21 '23 03:07 Dekkonot

I've since reversed my thoughts, we should probably kill that section haha. It's an unnecessary maintenance burden.

Dekkonot avatar May 20 '24 17:05 Dekkonot