Skip to content

Conversation

@aysunrhn
Copy link
Contributor

@aysunrhn aysunrhn commented Aug 29, 2025

I added a new section about software design, the information is at a high level and focuses on research software. It includes:

  • Practical guide to designing software architecture
  • C4 approach to software design
  • Additional resources (videos and etc.) and further reading

Closes #233

@aysunrhn aysunrhn requested a review from edvinskis August 29, 2025 14:53
- Updated categories
- Reworded introductory and some other paragraphs
- Fixed a yypo
- Standardized callout formatting
@edvinskis edvinskis changed the base branch from main to develop September 5, 2025 12:02
Copy link
Collaborator

@edvinskis edvinskis left a comment

Choose a reason for hiding this comment

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

Many thanks for this high-quality PR! I made a few minor revisions (updated categories, reworded introductory and some other sentences, fixed a typo, and standardized callout formatting).

I'll merge it now!

@edvinskis edvinskis requested a review from Copilot September 5, 2025 12:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a comprehensive software design guide focused on research software development. It introduces a new documentation section covering practical approaches to software architecture design, emphasizing principles specific to research contexts like reproducibility, transparency, and scientific collaboration.

Key changes include:

  • Created a complete software design guide with step-by-step implementation approach
  • Integrated the C4 modeling framework for documenting software architecture at multiple levels
  • Added extensive resources and references for further learning

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
docs/software/development_workflow/software_design.qmd New comprehensive guide covering software design principles, step-by-step implementation, and C4 modeling approach
docs/software/development_workflow/index.md Added feature section linking to the new software design guide
_quarto.yml Updated navigation to include the new software design page in the development workflow section

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@edvinskis edvinskis merged commit bc0e3c7 into TU-Delft-DCC:develop Sep 5, 2025
1 check failed
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.

Split up the SMP further reading

2 participants