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

Add README.md in install/ subproject #2324

Merged
merged 2 commits into from
Nov 2, 2021

Conversation

sir4ur0n
Copy link
Collaborator

@sir4ur0n sir4ur0n commented Nov 2, 2021

Closes #2309

Copy link
Member

@jneira jneira left a comment

Choose a reason for hiding this comment

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

Looks really great (modulo one minor change), thanks for complete the info

@sir4ur0n
Copy link
Collaborator Author

sir4ur0n commented Nov 2, 2021

What change? 😅

# hls-install

This directory contains the `hls-install` project, an Haskell Language Server installer.
It is used when [installing from sources](../docs/installation.md#building).
Copy link
Member

Choose a reason for hiding this comment

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

We are using absolute urls to readthedocs for links, see the main README as example

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done (and I took the liberty to fix a few other links in the documentation)

Copy link
Member

@jneira jneira Nov 2, 2021

Choose a reason for hiding this comment

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

oh, but links inside docs themselves can be (and should be i suppose) relative, we need absolute ones in external resources like README's

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh I see, my bad 🤦 I have force-pushed the fix

Copy link
Member

@jneira jneira Nov 2, 2021

Choose a reason for hiding this comment

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

dont worry, looks perfect now, i could be more specific, will update to head to get the ci fix

@jneira
Copy link
Member

jneira commented Nov 2, 2021

[skip circleci]

What change? sweat_smile

sorry i was looking why ci failed 😅

@sir4ur0n sir4ur0n force-pushed the sir4ur0n/doc/installDirectory branch from 348f8c1 to 9592921 Compare November 2, 2021 13:48
@jneira jneira added the merge me Label to trigger pull request merge label Nov 2, 2021
@mergify mergify bot merged commit 781a4e2 into haskell:master Nov 2, 2021
@sir4ur0n sir4ur0n deleted the sir4ur0n/doc/installDirectory branch November 2, 2021 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge me Label to trigger pull request merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify install/ sub-directory role, or integrate it into HLS project
2 participants