Skip to content

Conversation

andreww
Copy link
Collaborator

@andreww andreww commented Jun 17, 2025

A respin of #139 - I've set up read the docs which supports documentation generation on PRs. As this adds (lots of text) to the documentation we probably want that working for useful review.

The original PR said:

We've been asked to shorten the JOSS manuscript. I think the best bet is to remove the "how this works" material from the manuscript and put it into the documentation. This PR captures that work.

Thus far, this is just text lifted from the manuscript and converted into restructured text (if I have that correct).

andreww added 2 commits June 24, 2025 10:44
This is lifted from the manuscript and converted into
restructured text (if I have that correct).
…ation

Need to deal with the restructured text formatting!
@andreww
Copy link
Collaborator Author

andreww commented Jun 25, 2025

I think this one is probably best wrapped up after the JOSS manuscript is out. I think the material makes most sense in a documentation section that starts something like:

A brief outline of the motivation, approach and implementation of CATS can be found in a short paper published in the Journal of Open Source Software. We expand on that documentation here outlining a range of alternative approaches to reducing the carbon cost of computing ...

and then cover at least everything that is in the paper rather than just the stuff we chopped out. While we are at it, we should work in a reference and link to the Turing Way (see #135)

@abhidg
Copy link
Contributor

abhidg commented Sep 5, 2025

I'd add some subheadings, also fig1.png is missing

@andreww
Copy link
Collaborator Author

andreww commented Sep 17, 2025

Just adding a note here to check links in the various README files before this lands and make sure they point to readthedocs

@andreww
Copy link
Collaborator Author

andreww commented Sep 17, 2025

Also see #163 - we may as well do everything in one go (when I get time to look at this)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants