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

Refactor landing page and add pages for each usecase. #151

Merged
merged 5 commits into from
Sep 29, 2021

Conversation

romanowski
Copy link
Member

No description provided.

website/src/components/basicInstall.js Outdated Show resolved Hide resolved
<p>
scala-cli is built on top of coursier
<br/>
This allow us to manage Scala versions, dependencies and JVMs so you can test your code in different environments by changing single option.
Copy link
Contributor

Choose a reason for hiding this comment

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

I have doubt it should be here 'single option', because it requires changing a few options, not just one

Copy link
Contributor

Choose a reason for hiding this comment

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

One option is often enough, isn't it? Like --jvm 11, --scala-js, or --scala 2.13.

If you want to use older <b>version of Scala</b> or
run your code in <b>JS</b> or <b>Native</b> environments we've got you covered.
<br/>
<i>some additional <a href="TODO?">setup</a> may be required for JS and Native</i>
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Could you add documentation what and how should be installed to js section in the documentation and link it here? Do we need any specific setup for native?

@alexarchambault
Copy link
Contributor

The monospaced font everywhere makes it quite hard to read the descriptions, to me. It's fine for titles / headers, but I'm not sure for whole paragraphs.

@alexarchambault
Copy link
Contributor

Maybe we should agree on a precise convention to write Scala CLI. To me, when referring to the command itself, I write scala-cli (usually as code), and when referring to the project, I write Scala CLI (in two words, with Scala capitalized, and CLI in upper case).

@alexarchambault
Copy link
Contributor

alexarchambault commented Sep 27, 2021

Total NIT: I'm wondering how doable it would be to have two versions of the terminal GIFs, one for dark mode, one for light mode.

README.md Outdated Show resolved Hide resolved
website/docusaurus.config.js Outdated Show resolved Hide resolved
website/src/components/basicInstall.js Outdated Show resolved Hide resolved
<p>
scala-cli is built on top of coursier
<br/>
This allow us to manage Scala versions, dependencies and JVMs so you can test your code in different environments by changing single option.
Copy link
Contributor

Choose a reason for hiding this comment

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

One option is often enough, isn't it? Like --jvm 11, --scala-js, or --scala 2.13.

website/src/components/features.js Outdated Show resolved Hide resolved

<p>Scala-cli does not require any configuration file and all in-file configuration can be overridden by command-line.</p>

<p>No additional installation or setup of enviroment (like specific CWD) required.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you mean by "specific CWD"?

Copy link
Member Author

Choose a reason for hiding this comment

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

specific current working directory like whit sbt

@alexarchambault
Copy link
Contributor

@lwronski FYI, the CI error seems legit:

[39/39] packager.run 
Exception in thread "main" java.lang.ArrayIndexOutOfBoundsException: 28
	at net.sf.image4j.codec.ico.ICOEncoder.writeAndBitmap(ICOEncoder.java:352)
	at net.sf.image4j.codec.ico.ICOEncoder.write(ICOEncoder.java:219)
	at net.sf.image4j.codec.ico.ICOEncoder.write(ICOEncoder.java:120)
	at net.sf.image4j.codec.ico.ICOEncoder.write(ICOEncoder.java:106)
	at net.sf.image4j.codec.ico.ICOEncoder.write(ICOEncoder.java:41)
	at packager.windows.DefaultImageResizer$.generateIcon(DefaultImageResizer.scala:18)
	at packager.windows.WindowsPackage.$anonfun$build$2(WindowsPackage.scala:17)
	at scala.Option.map(Option.scala:242)
	at packager.windows.WindowsPackage.$anonfun$build$1(WindowsPackage.scala:17)
	at scala.Option.flatMap(Option.scala:283)
	at packager.windows.WindowsPackage.build(WindowsPackage.scala:16)
	at packager.cli.commands.Build$.run(Build.scala:52)
	at packager.cli.commands.Build$.run(Build.scala:15)
	at caseapp.core.app.CaseApp.main(CaseApp.scala:135)
	at caseapp.core.app.CommandsEntryPoint.main(CommandsEntryPoint.scala:112)
	at packager.cli.PackagerCli.main(PackagerCli.scala)

(originates from the new logo files?)

@MarcinAman
Copy link
Contributor

I think i am lacking some form of definition what is a simple project? Without an oral explanation from Krzysiek it is super hard to deduce what we call simple. Does simple mean only 1 file? Or maybe 1 package / module? Is using scala-js / native also considered simple?

in fact it would be super nice to have this definition somewhere on the index page. Maybe an asterisk with anchor link would do? Or even a paragraph just for this

@romanowski
Copy link
Member Author

@alexarchambault I unified how we use scala-cli and Scala CLI and changed the font in the body of the paragraphs.

As for the terminal, we probably need to use something a bit better than manually recording gifs (like asci-cinema) and then we can play with backgrounds etc. We need to update the content of the gifs anyway.

romanowski and others added 4 commits September 29, 2021 17:31
Co-authored-by: Alexandre Archambault <alexarchambault@users.noreply.github.com>
Co-authored-by: Łukasz Wroński <46607934+lwronski@users.noreply.github.com>
Simple projects -> single-module projects
Unifing naming od Scala CLI
Add border to gifs and images
detect windows automatically.
@romanowski romanowski merged commit f9a380a into VirtusLab:master Sep 29, 2021
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

4 participants