dwyl / dwyl/alog

Update documentation/README

Open
#18 0 comments 1 reaction 1 assignee Claimed by @SimonLab View on GitHub
T4h
Dominant language
Elixir
Stars
15
Forks
2
PR merge metrics
No merged PRs in 30d

Description

"Our first/next step is to make the docs for https://github.com/dwyl/alog super beginner friendly." :+1:
ref: https://github.com/dwyl/technology-stack/issues/67#issuecomment-437145610

see also https://github.com/dwyl/phoenix-ecto-append-only-log-example for an example on how to implement an append only logic with Phoenix.

Elixir v1.7 provide some new features for writing documentation:
from https://elixir-lang.org/blog/2018/07/25/elixir-v1-7-0-released/
![image](https://user-images.githubusercontent.com/6057298/48920328-3cf21700-ee90-11e8-9b79-e817ef0003fe.png)

Creating documentation with Hexdoc:
from https://hexdocs.pm/
![image](https://user-images.githubusercontent.com/6057298/48920544-5d6ea100-ee91-11e8-9576-36e3bbb117c2.png)

- https://hexdocs.pm/hex/Mix.Tasks.Hex.Publish.html
- https://hexdocs.pm/elixir/master/writing-documentation.html

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.