litestar-org / litestar-org/api-performance-tests

Docs: Add documentation

Open
#21 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
47
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Summary

Similar to https://polyfactory.litestar.dev/, have documentation that has a nice UI for people to look at the benchmarks. A place we can point people to.

https://benchmarks.litestar.dev/ (maybe we have to rename this repo 🤷🏽 )

Contributor guide

Open the contributing guide

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

Review the existing benchmark repository and the referenced polyfactory.litestar.dev and benchmarks.litestar.dev sites first. Define the documentation site's scope and whether the repository needs renaming; done means a polished, published UI for browsing the benchmarks that can be shared with users.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, performance
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.