PR: Set up design documentation and add dialogs section #58
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.
Slowly but surely, I am aiming to document design patterns across Spyder for the reference of the whole community. This is the very beginning of the process.
All of these documents are open to feedback and change. This is just the first public attempt for the project.
Changes
design-docs
directory to store this and future design-focused documentationdesign-docs
directory that states a basic purpose and index for further documentation.dialogs.md
, a mostly complete documentation of the design decisions we made when working on dialogs between Spyder 4 and 5. This will also serve as the bar for similar documentation of UI elements.images
directory for storing the images needed in the documentation. At the moment, this only holds images for the dialogs.Questions
Let me know if you have any questions or other feedback! Thanks for reviewing this PR!