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

Simplify Gradle layout, + KNIT, - ANK and fix site code fences #2584

Merged
merged 30 commits into from
Dec 1, 2021

Conversation

raulraja
Copy link
Member

@raulraja raulraja commented Nov 25, 2021

This PR is a joint effort with @JavierSegoviaCordoba and @nomisRev.

  1. Simplifies the gradle setup into a single project with all the modules, still preserves the folder layout.
  2. Moves a lot of the gradle config into https://github.com/arrow-kt/arrow-gradle-config
  3. Replaces Ank in favor of Knit and fixes all the docs broken snippets.
  4. Works around many dokka bugs where Dokka is incorrectly rendering markdown and code fences. For example, everything processed by DokkaGFM was returned as HTML escaped strings.
  5. Removes the need to have a build/_site which is where Ank was postprocessing the docs folder. @franciscodr We need you to please review the publishing workflow as the nesting in the docs does not exist anymore and most likely all steps related to removing the index file and copying the different versions need paths adjustments. I did my best but I don't understand how that works and I have no way to test it. Before this gets merged we need this final commit by @franciscodr ensuring the publishing of the site is going to work.

@raulraja raulraja marked this pull request as draft November 25, 2021 18:26
@raulraja raulraja changed the title [DRAFT] Add knit Simplify Gradle layout, + KNIT, - ANK and fix site code fences Nov 29, 2021
@raulraja raulraja marked this pull request as ready for review November 29, 2021 21:25
@franciscodr
Copy link
Collaborator

@raulraja @nomisRev You can check how the site will look in this link

Copy link
Member

@nomisRev nomisRev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@i-walker i-walker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏾 Nice

Copy link
Collaborator

@franciscodr franciscodr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

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.

5 participants