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

Add a "Getting Started" page & node documentation to the wiki #50

Open
Blade67 opened this issue May 27, 2023 · 1 comment
Open

Add a "Getting Started" page & node documentation to the wiki #50

Blade67 opened this issue May 27, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Blade67
Copy link

Blade67 commented May 27, 2023

Adding a "Getting Started" page to the wiki would make it much easier to understand how this addon works and how to set it up. The example repo helps, but it isn't the minimal setup one would want to integrate this into their project.

I suggest the following layout for the pages:

Getting started
  - Database
    - What is a database?
    - How to set it up
  - Item setup
    - What are items
    - How to create new items
    - Adding categories to items
  - UI setup
    - How does the UI work (with the inventory-system addon)
    - Setting up basic UI
    - Additional functionality

The documentation for the setup doesn't have to be extremely precise, but enough to get the basics done. In addition there should be complete documentation for each Node (Database, Item, etc.) that covers their properties, signals and what they extend from.

@scriptsengineer scriptsengineer self-assigned this May 27, 2023
@scriptsengineer scriptsengineer added the documentation Improvements or additions to documentation label May 27, 2023
@scriptsengineer
Copy link
Member

Yes, I believe that now that the module is more stable and with only additional features to enter, I intend to focus on putting a minimum amount of documentation in the project.

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