pydanny/fastapi-blog

Launch formal documentation site

Open

#11 opened on Feb 29, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5 forks)github user discovery
docshelp wanted

Repository metrics

Stars
 (35 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Much as this can be used as a light CMS, docs needs to be on Material for MKDocs hosted on RTD.

Contributor guide

Research direction
Set up Material for MKDocs configuration and deploy documentation to Read the Docs.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85