[WIP] Add documentation providing an intro to software development#225
Open
fiona-naughton wants to merge 2 commits intomainfrom
Open
[WIP] Add documentation providing an intro to software development#225fiona-naughton wants to merge 2 commits intomainfrom
fiona-naughton wants to merge 2 commits intomainfrom
Conversation
fiona-naughton
added
the
documentation
orbeckst
reviewed
Dec 19, 2024
Member
orbeckst
left a comment
orbeckst
left a comment
There was a problem hiding this comment.
I like the idea of providing more education on best practices in the context of the MDAKits — it fits well with the theme of ecosystem building.
The overall structure looks good (it's similar to the UGM2024 "fireside" talk, isn't it?). For now I'd keep the fairly terse pages and mostly work on linking to other content, the idea being that these pages give readers an overview of what is needed, and the means to dig deeper by themselves.
Perhaps you can think of styling (with CSS) that could give some visual structure to the common WHAT/WHY/HOW organization?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Here's the skeleton of the docs I want to add, providing an intro into software development concepts relevant to MDAKits; Issue #170 .
I've been working on this largely in Word (since that's easier) so do have a lot of this more fleshed out and will start moving it to a rst format, but figure I should at least get this skeleton up in case there are comments about things that should/shouldn't be covered.