docs: improved CONTRIBUTING.md and examples README#36
Open
SwasthikBangera wants to merge 8 commits intomatnoel:mainfrom
Open
docs: improved CONTRIBUTING.md and examples README#36SwasthikBangera wants to merge 8 commits intomatnoel:mainfrom
SwasthikBangera wants to merge 8 commits intomatnoel:mainfrom
Conversation
Added a comma for clarity in the simulation setup description.
Updated the overview section to clarify the library's capabilities and improve readability.
Revise overview for EasyFEA library
Fix grammar in CONTRIBUTING.md
Added a note for new users to start with HelloWorld.py.
Add introduction for new users to EasyFEA
Added a list of example simulation folders and their descriptions.
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
1 participant
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.
Summary :
-Made minor documentation improvements to improve readability for new contributors.
-Expanded the examples section with better structure to help users navigate the available simulations.
-These changes make it easier for first-time contributors and users to get started quickly.
-No code changes & functional impact.