Onboarding and developer documentation

[stefpiatek]

Definition of Done / Acceptance Criteria

Feel free to conver into sub issues and assign them, and create extra issues off this

• Top level docs directory with
  • UCLH infrastructure setup
  • developer setup
  • Design from the PIXL perspective
    • https://github.com/UCLH-Foundry/the-rolling-skeleton/blob/main/docs/design/100-day-design.md has current design. Edit and commit the .drawio and the .drawio.png to an img or similar subdirectory so that we can update this as the design changes
    • Think about any design decisions which aren't clear and make an issue to answer them
• Top level README points to docs as appropriate
• Services READMEs have been checked and it is clear
  • What their purpose is, and where they are used in the PIXL pipeline
  • How to run tests
  • High level functionality and entry points into the code if appropriate
• Any documentation in terms of the wider UCLH context rather than PIXL being added as PRs to the-rolling-skeleton

Testing

No response

Documentation

No response

Dependencies

• Documentation for new developers #242
• Document extract-radiology-reports CLI command #243
• Document need for pixl_config.yml file in PIXL CLI #244
• Create and populate docs/ directory for PIXL #245
• pixl-core is not highlighted in the project README #249
• pixl-dcmd installation does not work as described in the documentation #253
• Better description of pixl_dcmd in README  #257
• Add documentation for the PIXL database #306

Details and Comments

Very rough plan but expect this will evolve, main aim is to read code and documenation together