openworm / openworm/openworm_docs

Determine best practices for identifying stale content

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

Nobody has claimed this yet.

Dominant language
Python
Stars
45
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Docs quickly go out of date when issues get closed -- how should we figure out what goes stale and update it ASAP?

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 documentation workflow and the closed issues that prompted this request. Identify how stale content is currently detected and updated, then define a repeatable process for finding and refreshing documentation after related issues close. No files or tests are named in the issue.

Written by the indexing model from the issue text.

Assessment

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.