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

chore list for docs #114

Open
Barocena opened this issue Jul 20, 2023 · 2 comments
Open

chore list for docs #114

Barocena opened this issue Jul 20, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Barocena
Copy link
Contributor

Barocena commented Jul 20, 2023

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

  • Rojo docs needed changes
    • Main Page
    • 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 (Update installation page #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
    • 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)
@Dekkonot
Copy link
Member

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 Dekkonot added the documentation Improvements or additions to documentation label Sep 26, 2023
@Dekkonot
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants