microsoft/vasim

TODO: setup documentation generation

Open

#5 opened on Aug 30, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (7 forks)auto 404
TODOdocumentationhelp wanted

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

Description

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

Contributor guide

Research direction
Set up Sphinx documentation generation: create 'docs' directory, add conf.py, index.rst, and configure GitHub Pages or Read the Docs deployment.
Tech stack
python
Domain
developer experience
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
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80