Skip to content

Improve the documentation of this repository#8

Draft
memothelemo wants to merge 3 commits intodevfrom
pr/improve-docs
Draft

Improve the documentation of this repository#8
memothelemo wants to merge 3 commits intodevfrom
pr/improve-docs

Conversation

@memothelemo
Copy link
Copy Markdown
Member

@memothelemo memothelemo commented Nov 28, 2021

This open source game lacks further documentation of how certain things work which may lead to confusion for some people.

Things need to enhanced or added:

  • Setting up the entire repository and compile the game with TypeScript
  • It must have a wiki (non-git developer side) for setting up the repository for Windows nor MacOS users.
  • Improve the changelog
  • API references to App, CameraWorker, Placement and hook events.
  • List of Roact components used in the game (with roact-hooked hooks and context)
  • Guide of how to deploy the game to the public
  • Node scripts
  • Test the game using Rojo and Hoarcekat

@memothelemo memothelemo self-assigned this Nov 28, 2021
@memothelemo memothelemo added the documentation Improvements or additions to documentation label Nov 28, 2021
@github-pages github-pages bot temporarily deployed to github-pages November 28, 2021 15:57 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 28, 2021 16:01 Inactive
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

Successfully merging this pull request may close these issues.

1 participant