Skip to content

Initial version of the GreenPhysECS RSS#570

Merged
sparkslabs merged 7 commits intoEVERSE-ResearchSoftware:mainfrom
sparkslabs:greenphysecs_research_software_story
Jan 30, 2026
Merged

Initial version of the GreenPhysECS RSS#570
sparkslabs merged 7 commits intoEVERSE-ResearchSoftware:mainfrom
sparkslabs:greenphysecs_research_software_story

Conversation

@sparkslabs
Copy link
Collaborator

This is a draft pull request of a research software story created by using a GPT based interviewer.

The interviewer asks questions that probe the project in different ways and collates their answers and fills in the template. It prefers to use language that the user enters rather than language the user creates. (I'll share the prompts and support data separately) The key part of the prompt for report generation is:

- Produce continuous prose, section by section.
- Use interviewee language where possible.
- Prefer sentences and paragraphs for most sections except FAIR
- In the FAIR section use bullets for each aspect of Findable, Accessible, Interoperable, Reusability
- Use British English spelling.
- List open TODOs at the end.
- After the canonical story, generate optional appendices:
  - Lessons
  - Impact
  - Future Directions
- Fill in the sections of TEMPLATE_research_software_story.md and match it's format

The thing this draft lacks really is inline links to external sources of information.

It does count however as a tier 1 analysis code research software story.

This PR is created in part so I can see how this looks inside a netlify'd version of the markdown.

(There was a previous PR where my local branch was out of date, preventing building so I zapped that and this is a re-cfreation)

NB, this needs quite a few inline links adding
@netlify
Copy link

netlify bot commented Jan 24, 2026

Deploy Preview for everse-rsqkit-testing ready!

Name Link
🔨 Latest commit ecee6aa
🔍 Latest deploy log https://app.netlify.com/projects/everse-rsqkit-testing/deploys/697c8e225c58490008b0aae9
😎 Deploy Preview https://deploy-preview-570--everse-rsqkit-testing.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@sparkslabs
Copy link
Collaborator Author

This looks overall OK to me. (The content doesn't contain hallucinations and is either my phrasing, my phrasing tidied, or frankly better phrasing :-) etc)

Issues I can see before merge:

  • Needs inline links/references
  • The GPT suggested a small appendices section. I'm not sure about this. I'm happy to zap it, but it's an interesting addition. (On a +1 / 0 / +1 vote, I'd vote -0 on keeping the section)
  • I'd want to consider a note on how AI was used with this.

Copy link
Collaborator

@anenadic anenadic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks good to me @sparkslabs. Small comments but not blockers include:

  • adding inline links to tools, relevant task pages and external resources, as already discussed
  • perhaps consider putting each sentence on a new line if possible which is a guideline we agreed for all new pages (but not crucial)

* AtomECS paper: [https://arxiv.org/abs/2105.06447](https://arxiv.org/abs/2105.06447)
* AtomECS repository: [https://github.com/TeamAtomECS/AtomECS](https://github.com/TeamAtomECS/AtomECS)

# **Appendices**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# **Appendices**
## **Appendices**

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small tweak to be consistent with other headings in the case you keep this section @sparkslabs.

These were left in for interest, with expectation of removal,
but agreed it opens a can of worms we might not want to open
if left in. Hence removal.
Default export from Google Doc is one paragraph per line. Switched to one sentence per line.
Workflow was:
* GPT based interview
* GPT insertion into document
  - It should generate markdown, but renders as html
* Copy paste from webpage into google docs
* Then download as markdown
* Then insert metadata
* Review and edit

Hence the google docs comment above.
@sparkslabs
Copy link
Collaborator Author

As per discussion on mattermost, have:

Given approval above I'll also hit the merge PR button.

@sparkslabs sparkslabs merged commit 7232bae into EVERSE-ResearchSoftware:main Jan 30, 2026
9 checks passed
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