dwyl / dwyl/library

Docs

Open
#87 2 comments 1 reaction 0 assignees View on GitHub
enhancement good first issue help wanted
Dominant language
Elixir
Stars
16
Forks
1
PR merge metrics
No merged PRs in 30d

Description

We _need_ to build out this project ahead of opening [@home](https://github.com/dwyl/home/tree/e54255e6be9acf2ac39fabb7174605a4a19395d1#library-of-creativitytechnologybusiness-focussed-books) so that we have a systematic way of tracking the books. The first step is updating the docs so that we can be help `new` people wanting to contribute to the App can do so effectively.

@ZooeyMiller & @finnhodgkin made a good start on "whiteboarding" the architecture. #8
We need to export the schema diagram so that people can _understand_ the DB model visually.
Ideally the UX flow should be immediately obvious so anyone can understand it,
but we should still document it so that we have a reference point.

# Todo

Document the current:
+ [ ] What Features are working?
+ [ ] UX Flow
+ [ ] DB Schema
+ [ ] Entity Relationship Diagram
+ [ ] Dependencies used
+ [ ] https://github.com/dwyl/elixir-auth-github

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.