nim-works/nimskull

Write documentations for CGIR for developers

Open

#1,663 opened on Nov 29, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Nim (39 forks)auto 404
compiler/backenddocumentationgood first issue

Repository metrics

Stars
 (346 stars)
PR merge metrics
 (PR metrics pending)

Description

We need a document describing and helping developers work with the new CGIR introduced in #1625.

In particular, these points should be covered:

  • Grammar and node structure
  • Operational semantics
  • Places to look at to get an understanding on how to manipulate the code.

A brief discussion was done on Matrix and can be found here.

Contributor guide

Research direction
Study the CGIR structure introduced in PR #1625, understand the grammar, node structure, and operational semantics. Review the Matrix discussion for context. Look at existing IR documentation (if any) as a template.
Tech stack
None
Domain
compilers
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Nimcompiler concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70