scylladb / scylladb/python-rs-driver

Introduce documentation

Open
#130 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/documentation
Dominant language
Rust
Stars
6
Forks
7
Avg merge
5d 13h
Merged PRs (30d)
9

Description

This epic tracks the creation and update of our project documentation. It covers five main areas: getting started guides, core usage instructions, security protocols, observability/logging, and configuration references.

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

This is an epic covering getting started guides, core usage, security protocols, observability and logging, and configuration references, but it names no files, tests, or entry points. Start by locating the project’s existing documentation and splitting the work into those five areas; done means each area has the required documentation created or updated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.