Fundamental Documentation

[Cadair]

Things we need to document here:

• Creating a new package using the template
  • Install cookiecutter
  • Run cookiecutter
  • Answering questions, what they all mean etc
  • git init
  • How to use the CI configs, RTD and pre-commit
  • pre-commit (it runs as part of tox so needs to be run to make sure it passes).
• Updating a package with a new version of the template
  • .sunpy-template.yml
  • Run cookiecutter --no-input --config-file .sunpy-template.yml
  • review diff, drop some changes, stage others.
  • How to detect files removed by the template?
• Removal of astropy_helpers + upgrade from old templates.
  • https://docs.astropy.org/projects/package-template/en/latest/ape17.html
  • also _sunpy_init.py and other files no longer used.

[AbhiLohar]

Hi @Cadair I've been following the history of this issue and noticed the discussion regarding the empty docs/ci.rst file.

Having recently worked through the pre-commit and ReadTheDocs build issues on my recent PR (#483) for sunpy.org, I would love to help fill this gap by documenting the CI specifics for the template. I can cover how the automated checks work, how to handle common failures like line endings or indentation, and the importance of using tox for local verification.

Should I proceed with a PR specifically for docs/ci.rst?

[Cadair]

Mostly fixed by #305