Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

General updates to the website

Open
#337 19 comments 0 reactions 1 assignee View on GitHub

@abachma2 is already working on this.

Since Mar 21, 2024.

Assessment

This issue has not been assessed yet.

Description

0 - Backlog

This issue is meant as a list to keep track of various changes on the website, such as updates, typos, redesigns, etc. We will do our best to make sure things get updated in a timely manner. Please be sure to name the exact file that should be changed, and ideally the line(s) of the file to be changed.

To add a new item, please edit this comment, using a checkbox for each item

Moving all subtasks into the description so that they are tracked in a single place (@gonuke )

From our initial discussion (@nsryan2 ):

  • Remove mentions of VM support (people can build their own VM and then install cyclus inside it)
  • Remove mentions of cyclus-build-deps conda install mentions (there’s a flag you can use to install only dependencies from a conda package).
  • Update installation minimum packaging

Warnings/issues to handle (@abachma2 ):

  • #413
  • sourcec/cep/cep27.rst lines 32, 34,107, 113, 114, 123, 129, 137, 141, 151, 155, 156, 165, 171, 179, 183
  • source/cep/cep3.rst line 2
  • source/cite/index.rst line 47
  • source/newsletters/oct2017.rst line 111
  • source/previous/index.rst line 111
  • source/user/server.rst line 73
  • source/user/tutorial/add_deploy.rst line 37
  • source/user/tutorial/add_fab.rst line 4
  • source/user/tutorial/add_reg_inst.rst line 42, 58
  • source/user/tutorial/data_explorer.rst lines 121, 124, 192, 231, missing figures
  • source/user/tutorial/mod_rxtr.rst lines 35, 45
  • source/user/tutorial/run_cyclus_native.rst line 2
  • source/user/writing_input.rst line 65
  • source/arche/cmake.rst line 104

@abachma2 :

  • Update the website with new version information.
  • Reflect change of default branch to main

@nuclearkatie

@abachma2 :

@dean-krueger 👍

  • Method to install setup.py in Python Archetype Development Tutorial is outdated. Switch to using pip
  • Cyclus Inputs Tutorial instructs users to use "-" in names, Cyclus returns an error if this is done. Replace with "_"?
  • #412
  • Missing ">" in example input file for Adding a Separations Facility (Home >> CYCLUS User Guide >> CYCLUS User Tutorial >> Adding a Separations Facility) near the bottom of the file.
  • C++ Tutorial "Hello World" has incorrect install instructions: the cycstub github page has different instructions and says that the method described on the tutorial page is "Depreciated" (#197, #366)
Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from cyclus/cyclus.github.com

All issues in cyclus/cyclus.github.com

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.