cyclus / cyclus/cyclus.github.com

Should we add a page about the VS Code extensions -- would require reformatting tutorial to call up the automatically created blocks

Open
#432 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Description

With the updates to the tutorial, do we want to add parts about the VS Code extensions?

I think at the least we should adjust the tutorial to use the cyclus -n arg command to help create the input file, and then edit from there. I'm not sure how that relates to the VS Code extensions component that we have been talking about.

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 existing tutorial and the discussion about the VS Code extensions, then try the cyclus -n arg command to understand the proposed workflow. Clarify whether the tutorial should be reformatted and whether a dedicated extensions page is wanted; done means the scope is agreed and the tutorial and any new page consistently document the chosen workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
vscode
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.