Document the concept of ggsql's internal representation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 554
- Forks
- 30
- Avg merge
- 17h 27m
- Merged PRs (30d)
- 8
Description
I couldn't find this on the website but ggsql exists as three parts: the reader, the builder and the writer.
We should explain:
- That there are three parts
- What the reader does
- What the builder does
- What the writer does
- How the parts interact, i.e. builder talks to reader for queries.
- For each part, what modules are available (e.g. the backends and writers)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the website documentation and the reader, builder, and writer modules in ggsql. Read how these parts interact, especially how the builder talks to the reader for queries, and identify the available backends and writers. Done means the documentation explains the three-part representation, each part’s role, their interactions, and the available modules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100