Misc doc changes #247
Misc doc changes #247
Conversation
|
@kianmeng Thanks for the pull request. I have a few questions and change requests though. First, I'm not sure what you mean by "this commit ensures the generated Second, you made some additional changes to other files that seem unrelated to the description. For example, some changes to the Also, some of the formatting changes made to the README file itself are unneeded. I'm not very interested in adding badges for the code coverage amount, or the last commit information. Some indentation and whitespace changes within the README content as well are not necessary as well. |
README.md
Outdated
|
|
||
| Copyright (c) 2016 Infinite Red, Inc. | ||
|
|
||
| This software is released under the [MIT License](./LICENSE.md). |
There was a problem hiding this comment.
This whole added section is not needed (somewhat incorrect) and can/should be removed.
There was a problem hiding this comment.
You're right about the incorrectness, it supposed to be:
Original work Copyright (c) 2016 Infinite Red, Inc.
Modifed work Copyright (c) 2019 MojoTech, LLC.
I've removed it as requested.
| elixir: "~> 1.8", | ||
| start_permanent: Mix.env() == :prod, | ||
| compilers: [:phoenix, :gettext] ++ Mix.compilers(), | ||
| name: "Torch", | ||
| description: "Rapid admin generator for Phoenix", | ||
| source_url: "https://github.com/mojotech/torch", | ||
| homepage_url: "https://github.com/mojotech/torch", |
There was a problem hiding this comment.
Why are we removing this line for homepage_url?
There was a problem hiding this comment.
My bad. Added it back.
kianmeng
force-pushed
the
misc-doc-changes
branch
from
7985e1a to
2868b3d
Compare
Besides other documentation changes, this commit ensures the generated HTML doc for HexDocs.pm will become the source of truth for this Elixir library and leverage on latest features of ExDoc.
kianmeng
force-pushed
the
misc-doc-changes
branch
from
2868b3d to
160f9eb
Compare
@cpjolicoeur Thanks for the feedback and letting me know your preference.
Basically all related documents in the repository like
Reverted these changes.
Likewise, changes reverted. |
|
Thanks @kianmeng for this Pull Request. I made some small changes to your README updates to make sure keys were set in the proper sections in the mix file. |
Besides other documentation changes, this commit ensures the generated
HTML doc for HexDocs.pm will become the source of truth for this Elixir
library and leverage on latest features of ExDoc.