scipp / scipp/ess

Generic documentation content

Open
#154 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

essreduce
Dominant language
Python
Stars
1
Forks
3
Avg merge
2d 11h
Merged PRs (30d)
17

Description

Related to scipp/ess#354.

Where should this go? A page in the user-guide? A new section, similar to Recipies in Sciline?

Content to consider for inclusion

Contributor guide

Open the contributing guide

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

Review the related scipp/ess#354 issue and the plotting event-data workflow discussion in issue #420. Decide whether this belongs in the user guide or a new section modeled on Sciline's Recipes page, then document the agreed plotting workflow content and placement.

Written by the indexing model from the issue text.

Assessment

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.