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

Documentation: Redesign #65

Open
SirMallard opened this issue Aug 12, 2024 · 2 comments
Open

Documentation: Redesign #65

SirMallard opened this issue Aug 12, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@SirMallard
Copy link
Owner

The current documentation is fairly limited and does not provide a good explanation of many of the important aspects of using Iris. A general overhaul of information and better tutorials and teaching is needed for the documentation so that it goes beyond just being an API info section.

@SirMallard SirMallard added the documentation Improvements or additions to documentation label Aug 12, 2024
@SirMallard SirMallard added this to the v2.4.0 milestone Aug 12, 2024
@SirMallard SirMallard self-assigned this Aug 12, 2024
@warprbx
Copy link

warprbx commented Aug 13, 2024

I agree, had to look in the demo to understand it haha

@SirMallard SirMallard removed their assignment Sep 4, 2024
@SirMallard
Copy link
Owner Author

I've been working on improving the overall documentation which is visible on the docs branch at the moment. It will take a bit of time to update everything and include enough additional information to properly explain how Iris works and the best ways to integrate it into a game.

@SirMallard SirMallard changed the title Redesign documentation Documentation: Redesign Oct 18, 2024
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

When branches are created from issues, their pull requests are automatically linked.

2 participants