README instructions

[cboustred]

Hi,

I was having a little read of this and think the README might be out of date related to setting up the initial project, perhaps after the cookiecutter option was removed?

see here: https://github.com/turva-uk/dcb0129-template#initial-generation-of-clinical-safety-management-file

It states:

"Enter your project-, team- and organisation-specific information in response to the command line prompts."

I'm not sure what's meant to be making those prompts? Perhaps originally it was cookiecutter but now thats not the case?

Apologies if I'm well off track, keen to have a play with your approach

Thanks for the work!

Chris

[pacharanero]

Hi @cboustred - you're absolutely right it's a hangover from when CookieCutter used to prompt the user in the CLI for the organisation/project specific variable values, which it would then bake into the text.

We have since shifted away from CookieCutter because it was very 'fragile' - the slightest deviation from clean and valid input during the 20 questions it would ask you, and it would crash theatrically 🤣

So now we use Mkdocs Macros - fill in the placeholders in mkdocs.yml and those will be filled in by Mkdocs during the page build process. It's a better solution I think, allows you to change the details later, and much more robust.

However there's a slight problem on the horizon - Mkdocs 2 is being rebuilt from the ground up and will not have plugins, which means Macros won't work. see https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/

For the time being everything here should still work. Ignore anything that says there will be 'prompts' as there won't be.

If you like this repo, you may be interested in some relatedwork I've just started, working with arckit to develop Clinical Safety versions of their AI-generation tooklits. This kind of documentation is absolutely ripe for AI support - the AI scaffolds out a good CSMF, you edit, tweak, and review as CSO. tractorjuice/arc-kit#501

But most of all if you've found this repo useful Star it! and if you have any feedback just let me know!

[pacharanero]

I've pushed some changes today that update the README to fix this issue.
Thanks for reporting @cboustred and do get in touch if I can help with your use of these repos