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

Broken link of "example project" in docs #117

Closed
NicolaeNMV opened this issue Jan 28, 2024 · 1 comment
Closed

Broken link of "example project" in docs #117

NicolaeNMV opened this issue Jan 28, 2024 · 1 comment

Comments

@NicolaeNMV
Copy link
Contributor

NicolaeNMV commented Jan 28, 2024 •
edited
Loading

Hi,

First of all I want to thank the author of this project for the amazing work.

So I wanted to try out the cask library, I went to the documentation page https://com-lihaoyi.github.io/cask/

But it appears that the download link is broken. I'm getting a "Not Found" github page.
I see that the code that does the pre-processing is in docs/build.sc.

I would like to contribute a bit more, if that's okay. Mainly on docs.

  1. It would be nice to create a separate github project that anyone can run git clone. I believe that everyone has git installed, and there is more trust when getting something directly off git. I see that is a widely popular method of onboarding (spring boot, akka-http, play).
  2. Provide the dependencies in the format of multiple build tools that can be copied. I feel like allowing the use of the widely popular build tools is a good idea for onboarding: maven, sbt, mill. A bit like akka-http did it for sbt and maven.
    After all, I don't think anyone will change their build tool just for one project. There is a bigger game ; ) I think the simple style of Scala is very appealing!
  3. The cask server doesn't print the port when it starts.
  4. There is a link to gitter from the docs, I think now the community is on discord. I will raise a PR for this one.
@NicolaeNMV NicolaeNMV mentioned this issue Jan 28, 2024
Merged
lihaoyi pushed a commit that referenced this issue Feb 2, 2024
@NicolaeNMV
Minor docs update. Update badges. (#118)
9537d54 
I've noticed that the badges could benefit from some polishing, as
mentioned in #117.

1. The travis badge doesn't appear to work anymore.
2. I've noticed that the community is now on discord and that gitter has
very low activity.
I see that the #com-lihaoyi discord channel is pretty active.

I did manage to generate the docs using `./amm build.sc` with java 8,
and here how the docs page looks now.

<img width="1286" alt="Screenshot 2024-01-28 at 23 53 11"
src="https://github.com/com-lihaoyi/cask/assets/224201/2efedbba-34f9-4619-b771-b9b1a4e866f3">

I could also update the README of the project with the badge to discord.
@lihaoyi
Copy link
Member

lihaoyi commented Feb 2, 2024

Fixed in b51c072

Thanks for the report!

@lihaoyi lihaoyi closed this as completed Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@NicolaeNMV @lihaoyi