Skip to content

[FEATURE] Documentation #230

Closed
2 of 2 issues completed
Closed

Description

@tema3210

Summary

Specification request

Motivation

Would really be nice to have because:

  • having to scheme parser and co is very unpleasant at the very least
  • would benefit the project itself so that other authors would see what this project is supposed to be vs what it actually is
  • enables formal analysis
  • allows others to read the syntax

Desired contents

  1. EBNF (or alternative) of the query language syntax
  2. Semantics of operations
  3. Some tutorials on the usage

P.S. Nice project, thx for work

Activity

  1. adityamukho commented on May 4, 2026

    @adityamukho
    Collaborator

    Acknowledged.

    1. A formal grammar (EBNF or other) for the syntax should be provided. This will directly address your primary requirement, and will be prioritized.
    2. https://github.com/project-minigraf/minigraf/wiki/Datalog-Reference for operation semantics. This covers semantics for all supported operations including bi-temporal queries, negation, aggregation, window functions, and expressions.
    3. Tutorials are a bit sparse at the moment, but here's what I currently have:
      1. https://github.com/project-minigraf/minigraf/wiki/Use-Cases for a broad overview of possible integration points and some starter code.
      2. Some language-specific example code under the examples folder.
      3. Several execution examples in the demos folder.
      4. A live playground to experiment and learn by trial and error - https://minigraf-playground.vercel.app/ (Very early stage concept at the moment).

    Additionally, you can find more learning resources at https://github.com/project-minigraf/minigraf/wiki/Learning-Resources

  2. adityamukho commented on May 13, 2026

    @adityamukho
    Collaborator
  3. adityamukho commented on May 15, 2026

    @adityamukho
    Collaborator

    Tutorials now available at https://github.com/project-minigraf/minigraf/wiki#tutorials.

    This addresses all points raised in this ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions