Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.
This repository was archived by the owner on Aug 4, 2025. It is now read-only.

Proposal for having a tutorial document or separate guides for glee.  #431

@Souvikns

Description

@Souvikns

Reason/Context

Currently, it is hard to get started with Glee as a new user, we need some kind of documentation that talks about:

  • how to install and setup Glee
  • achieve what we are trying to do (details on what tweaks we can make)
  • how to deploy glee.

I think it would really benefit from having tutorial documentation for Glee so as to talk about different features Glee has and also as a user manual for new users to learn from, something like reactjs tutorial, or we can have a guides sections where we can have setup by setup guides for achieving certain things, and when we have new features we can create guides to showcase them.

We need to decide if it is something that would be beneficial, and if we decide on this, how should we go about it, should this be on the website or in the Readme, or on wikis?

Specific Goals

Just defining what we need to document

  • We need to document a getting started guide where we help the user set up a glee project and help him get started with the project.
  • Docs that talk about details on different features of glee, like what are different lifecycle events and how to use them, docs on config, etc.

pinging @fmvilas @KhudaDad414

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions