jose-compu / jose-compu/opencircom

docs: Add circuits/README.md template index with include paths

Open Beginner friendly
#33 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted priority: low
Dominant language
Circom
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

## Why
Many templates under `circuits/`; newcomers need include paths in one place.

## Task
Add `circuits/README.md` listing major templates (hashing, merkle, comparators, voting, etc.) with example `include "..."` lines.

## Acceptance
- [ ] Paths match tree
- [ ] Linked from main README

## Difficulty
Beginner — documentation only.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the circuits/ tree and the existing main README. Create circuits/README.md with major template paths and example include lines, then link it from the main README. Done means the listed paths match the tree and the index is reachable from the main README.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.