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

Initial edits to Overview and Commands #277

Merged
merged 2 commits into from
Oct 27, 2021

Conversation

alvinj
Copy link
Contributor

@alvinj alvinj commented Oct 25, 2021

These are my initial edits to the Overview page and all of the pages in the Commands section.

@alvinj
Copy link
Contributor Author

alvinj commented Oct 25, 2021

A few notes to go along with this:

  • The source code on lines 28+ of package.md is commented-out
  • In package.md, the default format is called a "lightweight launcher JAR" and then later as "bootstraps", so I added the bootstrap term earlier
  • The latest tag is mentioned on line 88 of package.md but isn’t used in the command
  • The DEB/RPM/PKG/MSI links on lines 166+ of package.md may be broken
  • The 'pkg' command on line 241 of package.md may be wrong
  • The 'msi' command on line 261 of package.mdmay be wrong
  • In fmt.md, it talks about scalafmt.conf files (under Dialects), but under Current Limitations it says they aren’t supported (lines 23+)
  • Reading the docs in linear order, in clean.md, line 6, I don’t yet know what the .scala directory is
  • I’m not sure if what I wrote at the beginning of setup-ide.md is correct (about manually running the command)

@romanowski
Copy link
Member

I've resolved the conflicts.

As for the notes:

The source code on lines 28+ of package.md is commented-out

This is our current way to show the output of the command. @MarcinAman is working on a proper UI widget.

The latest tag is mentioned on line 88 of package.md but isn’t used in the command

It is added by docker (but we wanted to mention it explicitly)

The DEB/RPM/PKG/MSI links on lines 166+ of package.md may be broken

Fixed that

In fmt.md, it talks about scalafmt.conf files (under Dialects), but under Current Limitations it says they aren’t supported (lines 23+)

I've reworded the section to be more clear.

Reading the docs in linear order, in clean.md, line 6, I don’t yet know what the .scala directory is

I've reworded the section to be more clear.

I’m not sure if what I wrote at the beginning of setup-ide.md is correct (about manually running the command)

Looks ok.

@romanowski romanowski merged commit 5848d09 into VirtusLab:master Oct 27, 2021
@alvinj
Copy link
Contributor Author

alvinj commented Oct 27, 2021

As for the notes:

Thank you for resolving the changes, and resolving my questions/comments!

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.

2 participants