Skip to content

Add Comprehensive “Getting Started” Guide with End-to-End First Project Walkthrough #3959

@lovelymahor

Description

@lovelymahor

The current README introduces Graphite well, but it does not provide a clear onboarding path for new users or contributors.

Beginners may face difficulty with:

Setting up the project locally
Understanding the node-based workflow
Creating their first design after launching the editor

This increases the entry barrier and can discourage potential contributors.

Proposed Solution -

Add a dedicated “Getting Started” section (in README or a separate document) that includes -

Quick Setup Guide
List of prerequisites (Rust, Node.js, etc.)
Step-by-step installation instructions
Commands to run the project locally
First Project Walkthrough
Create a simple shape
Apply a procedural pattern
Use node graph editing
Export the output
Simplified Explanation of Node-Based System
Basic concept of node-based editing
How it works in Graphite
A simple visual or example
Project Structure Overview
Explanation of key folders
Where new contributors should begin
Expected Outcome
Easier onboarding for new users
Increased contributor participation
Better understanding of the tool’s core concepts
Improved overall developer experience

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions