Skip to content

Adding Software Design Document to mole-docs.readthedocs.io#352

Open
Tony-Drummond wants to merge 6 commits intomainfrom
docs/add_software_design
Open

Adding Software Design Document to mole-docs.readthedocs.io#352
Tony-Drummond wants to merge 6 commits intomainfrom
docs/add_software_design

Conversation

@Tony-Drummond
Copy link
Copy Markdown
Collaborator

Adding the software design guidelines document in markdown format

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Example
  • Documentation

Description

Related Issues & Documents

QA Instructions, Screenshots, Recordings

Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, as well as any relevant
images for UI changes.

Added/updated tests?

_We encourage you to test all code included with MOLE, including examples.

  • Yes
  • No, and this is why: please replace this line with details on why tests
    have not been included
  • I need help with writing tests

Read Contributing Guide and Code of Conduct

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Adding the software design guidelines document in markdown format
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md
Comment thread MOLE_SW_DESIGN.md
@Tony-Drummond
Copy link
Copy Markdown
Collaborator Author

Thank you @valeriabarra most of your suggestions have been incorporated. The HTML lines are kept but now they appear properly in the html code format.

@Tony-Drummond
Copy link
Copy Markdown
Collaborator Author

@valeriabarra could you approve and merge this PR? Thanks

Comment on lines 57 to 59
<!-- [MENU links to be added later]: #
[Communications <intros/communications_wrapper]: #
[Upcoming Events <intros/upcoming_events_wrapper>]: # -->
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hi @Tony-Drummond , I know it does not pertain this PR, but now that we have a project website these place holders should be removed from here (they cause warning messages for links not found). It is a small change that you could please add to this PR. Thank you

Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md Outdated
Comment thread MOLE_SW_DESIGN.md
Comment thread MOLE_SW_DESIGN.md
Complete revisions to the Software Design Document (Valeria, Jared and Tony)
@Tony-Drummond Tony-Drummond force-pushed the docs/add_software_design branch from 0e33ac2 to fbda99a Compare May 5, 2026 21:11
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.

Adding MOLE Software Design Guidelines Document

3 participants