py4dstem / py4dstem/py4DSTEM

v15 documentation updates

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

Nobody has claimed this yet.

v15
Dominant language
Python
Stars
279
Forks
177
PR merge metrics
No merged PRs in 30d

Description

  • docs are up to date
  • clarify autoupdate pipeline in internal drive docs
  • clarify process for modification and confirmation of edits CONTRIBUTORS.md
  • translate to numpy-style docs

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 checklist and CONTRIBUTORS.md, then locate the internal-drive documentation referenced for the autoupdate pipeline. Clarify the edit-confirmation process and translate the documentation to numpy-style conventions; the work is done when all four checklist items are addressed and checked.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.