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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #78

Merged
merged 5 commits into from
Apr 29, 2024
Merged

Improve documentation #78

merged 5 commits into from
Apr 29, 2024

Conversation

szymon-jez
Copy link
Member

@szymon-jez szymon-jez commented Mar 9, 2024 •
edited
Loading

Changes:

  • Update copyright year
  • Fix LICENSE.md missing in documentation
  • Unhide the main module from docs
  • Include CHANGELOG.md in docs

This will address warnings described in #38 (comment).

This was already successfully deployed to hex.pm docs.

@szymon-jez szymon-jez force-pushed the sj/slightly-improve-documentation branch from 663736d to dd805ca Compare March 9, 2024 09:38
@szymon-jez szymon-jez force-pushed the sj/slightly-improve-documentation branch from dd805ca to 1410e50 Compare March 9, 2024 11:22
@szymon-jez szymon-jez changed the title Slightly improve documentation Improve documentation Mar 9, 2024
@szymon-jez szymon-jez marked this pull request as ready for review April 26, 2024 17:39
@szymon-jez szymon-jez merged commit 312afb3 into master Apr 29, 2024
10 checks passed
@szymon-jez szymon-jez deleted the sj/slightly-improve-documentation branch April 29, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@josemrb josemrb josemrb approved these changes

@kamilkowalski kamilkowalski Awaiting requested review from kamilkowalski

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szymon-jez @josemrb