tonsky / tonsky/datascript

Documentation?

Open
#135 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Clojure
Stars
5.8k
Forks
318
PR merge metrics
No merged PRs in 30d

Description

This project has my interest, and I'd also like to use it in my project, if it's capable of what I think it is. But... there's no documentation linked. Zero. Nothing. Where do I find the API? And a useful introduction?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's current public API entry points and any existing project overview material. Define the documentation scope around a useful introduction and API guidance, then verify that a new user can find both from the project page and understand how to begin using DataScript.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure, javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.