search

elixir-crawly / crawly

Crawly, a high-level web crawling & scraping framework for Elixir.
https://hexdocs.pm/crawly
Apache License 2.0
976 stars 115 forks source link

Misc doc changes #197

Closed kianmeng closed 2 years ago

kianmeng commented 3 years ago

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.

Ziinc commented 2 years ago

@kianmeng looks like theres 4 diff types of changes:

  1. license file changes + addition to readme
  2. doc badge linking
  3. test file adjustments
  4. mix file adjustments

can we split up this pr into two PRs. I can merge in 2,3,4. But pt1 is up to @oltarasenko

Ziinc commented 2 years ago

Also, could you resolve conflicts for the quickstart changes? there has been some changes in the quickstart spider example.

oltarasenko commented 2 years ago

@kianmeng looks like theres 4 diff types of changes:

  1. license file changes + addition to readme
  2. doc badge linking
  3. test file adjustments
  4. mix file adjustments

can we split up this pr into two PRs. I can merge in 2,3,4. But pt1 is up to @oltarasenko

I am not quite sure why do we need to remove something from the licence? Could you explain?

kianmeng commented 2 years ago

Also, could you resolve conflicts for the quickstart changes? there has been some changes in the quickstart spider example.

@Ziinc Done. Please check.

kianmeng commented 2 years ago

@kianmeng looks like theres 4 diff types of changes:

  1. license file changes + addition to readme
  2. doc badge linking
  3. test file adjustments
  4. mix file adjustments

can we split up this pr into two PRs. I can merge in 2,3,4. But pt1 is up to @oltarasenko

I am not quite sure why do we need to remove something from the licence? Could you explain?

@oltarasenko @Ziinc Just remove APPENDIX from the licence, which is not part of the license terms and agreements.

oltarasenko commented 2 years ago

@kianmeng looks like theres 4 diff types of changes:

  1. license file changes + addition to readme
  2. doc badge linking
  3. test file adjustments
  4. mix file adjustments

can we split up this pr into two PRs. I can merge in 2,3,4. But pt1 is up to @oltarasenko

I am not quite sure why do we need to remove something from the licence? Could you explain?

@oltarasenko @Ziinc Just remove APPENDIX from the licence, which is not part of the license terms and agreements.

Ok, I don't have objections in this case I think!

kianmeng commented 2 years ago

@Ziinc I can't seem to reply to your comment, so I put everything here.

any reason why this change is necessary? It would be preferable to leave as is to prevent major ver api changes from breaking docs generated.

Use the latest ExDoc to generate the documentation to leverage its latest features.

any reason why the aliases is removed? it is used for doc gen.

This is similar to using the assets option for Exdoc:

   defp docs do
     [
-      source_ref: "v#{@version}",
+      assets: "documentation/assets",

See https://hexdocs.pm/ex_doc/Mix.Tasks.Docs.html#module-configuration

:assets - Path to a directory that will be copied as is to the "assets" directory in the output path. Its entries may be referenced in your docs under "assets/ASSET.EXTENSION"; defaults to no assets directory.

kianmeng commented 2 years ago

@Ziinc @oltarasenko Any updates on this?

Ziinc commented 2 years ago

@kianmeng merge requires all checks to pass, i'll fix the checks when I'm free. i'll try to get this merged in this week.

oltarasenko commented 2 years ago

@kianmeng Could you please run mix format and send it back, so I can merge it?

kianmeng commented 2 years ago

@oltarasenko Done. Please check.

kianmeng commented 2 years ago

:tada: :tada: :tada: :tada: :tada: