cyclus / cyclus/cyclus.github.com
Document that the XML schema has been fixed and how to use it
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
PR 1846 from Cyclus/Cyclus fixed the XML schema grammar and allows the VS Code XML plugin by Red Hat to become a very powerful tool for generating input files (especially for new users). This feature should be documented on the website (likely as a part of this tutorial). Specifically:
- Document that the schema grammar is a really powerful tool for generating input files and recommend/explain its use
- Document which VS Code plugins need to be installed to enable this tool
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the website tutorial at fuelcycle.org/user/tutorial/index.html and review PR 1846 for the XML schema changes referenced in the issue. Document the schema's input-file generation benefits and identify the VS Code plugins, including Red Hat's XML plugin, needed to use it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100