Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR: Set up design documentation and add dialogs section #58

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

isabela-pf
Copy link
Collaborator

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

  • Adds a design-docs directory to store this and future design-focused documentation
  • Adds a readme in the design-docs directory that states a basic purpose and index for further documentation.
  • Adds 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.
  • Adds an images directory for storing the images needed in the documentation. At the moment, this only holds images for the dialogs.

Questions

  • Do we want to add a license to this repo as it starts to actually hold content and not just issues?

Let me know if you have any questions or other feedback! Thanks for reviewing this PR!

@isabela-pf isabela-pf added the documentation Improvements or additions to documentation label Jul 16, 2021
@CAM-Gerlach
Copy link
Member

@ccordoba12 Should we go ahead and merge this as a starting point? Or is it no longer up to date/relevant?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants