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

Misc doc changes #14

Merged
merged 1 commit into from
Dec 10, 2023
Merged

Misc doc changes #14

merged 1 commit into from
Dec 10, 2023

Conversation

kianmeng
Copy link
Contributor

Besides other changes, this commit ensures the generated HTML doc for
HexDocs.pm will become the main source doc for this Elixir library which
leverage on ExDoc features.

List of changes:

  • Fix typos
  • Use common source url
  • Use and set ex_doc to latest version
  • Add changelog to hex info page
  • Set readme as main html page
  • Add changelog to html page
  • Badges and more badges!
  • Update gitignore
  • Update formatter config
  • Add license section

Besides other changes, this commit ensures the generated HTML doc for
HexDocs.pm will become the main source doc for this Elixir library which
leverage on ExDoc features.

List of changes:
* Fix typos
* Use common source url
* Use and set ex_doc to latest version
* Add changelog to hex info page
* Set readme as main html page
* Add changelog to html page
* Badges and more badges!
* Update gitignore
* Update formatter config
* Add license section
@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.552% when pulling 392fe4d on kianmeng:misc-doc-changes into 3e3bb4e on PragTob:main.

@kianmeng
Copy link
Contributor Author

@PragTob Any updates on this?

@PragTob
Copy link
Owner

PragTob commented Dec 10, 2023

@kianmeng sorry, it's been a busy time and at some point I forgot about them, all in one commit is also not easiest to handle. I'll see if merging it is possible otherwise I'll redo the changes like on benchee_html

@PragTob PragTob mentioned this pull request Dec 10, 2023
@PragTob PragTob merged commit 7bf85bd into PragTob:main Dec 10, 2023
@kianmeng
Copy link
Contributor Author

🥳 🥳 🥳 🥳 🥳

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

Successfully merging this pull request may close these issues.

None yet

3 participants