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

Add designs to a documentation folder #7

Open
nherriot opened this issue Feb 13, 2019 · 0 comments
Open

Add designs to a documentation folder #7

nherriot opened this issue Feb 13, 2019 · 0 comments

Comments

@nherriot
Copy link
Contributor

From notes taken it FOSDEM 2019, it seems to be clear that i need to put our design documents into a document folder in the case where people may want to try this out, but understand how the thing actually works!

  1. Take sequence diagrams and place into a design folder.
  2. Take architecture diagrams and place into a design folder.
  3. Consider having a readme or WiKi to discuss all this and explain how the thing works.
  4. Implement a WiKi anyway - it needs to have diagrams on how it works and what it looks like.
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

No branches or pull requests

1 participant