lenskit / lenskit/parinvoke

Write parinvoke manual

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We need a manual, published to readthedocs.

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing the parinvoke project and its existing documentation, then determine what the manual should cover. Define the manual's scope and the Read the Docs publishing requirements before work begins; done means a usable manual is published to Read the Docs.

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.