Missing section on transferring existing project to the template

[brynpickering]

Description

There are instances where we want to align an existing, relatively mature project to the template. This requires some careful transplanting work to which we'd benefit from documenting an approach.

E.g.,

1. Create a dummy local repo in some other place on your device using the template tutorial steps.
2. Copy across the parts of the "clean" repo one by one, aligning as you go.
3. Likely start by moving the source code into one place (src/[module-name]), then the test folder, then the requirements directory and pyproject.toml (update requirements/base.yaml to include your project requirements). Hopefully that will be enough to start running tests to make sure everything still works.
4. Move docs/ and mkdocs.yml to start re-constructing the docs.
5. Any scripts with if __name__ == "__main__" calls should be in src/[module-name]/cli.py as command-line interface commands.
6. Any example Jupyter Notebook scripts should be in examples.

Related links

Version

v0.2.0

Proposed change

No response