PolicyEngine / PolicyEngine/policyengine-us

Add documentation through Readme.md files to the repository

Open
#5,034 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
163
Forks
213
Avg merge
3d 3h
Merged PRs (30d)
96

Description

Creating new readme files as guidance of parameters, variables tests, etc.

Contributor guide

Open the contributing guide

Research direction

The issue mentions creating new Readme.md files to guide contributors on parameters, variables, and tests, but gives no repository paths or existing documentation targets. Start by surveying the repository for areas lacking README guidance. Done means adding focused README files that explain those topics clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
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.