SeaQL/sea-orm

No reference to features list or alternate DB connectors in docs.

Open

#2,332 opened on Aug 16, 2024

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)Rust (718 forks)auto 404
Area:docsCategory:enhancementgood first issue

Repository metrics

Stars
 (9,827 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

Going to https://docs.rs/sea-orm/1.0.0/sea_orm/index.html and searching for "mysql" "sqlite" or "pgsql" does not show you what features are needed to be enabled or disabled for those backends.

This makes it hard for a new user since they should be able to find these features when reading this page.

Contributor guide

Research direction
Find the documentation page at https://docs.rs/sea orm/1.0.0/sea orm/index.html and identify where to add a note about feature flags for database backends. Then update the documentation source (likely in the README or docs directory) to include a reference to the features list.
Tech stack
rust
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
GitRustCargo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90