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 fix mdoc supersede 277 #339

Merged
merged 3 commits into from Jul 27, 2021
Merged

Add fix mdoc supersede 277 #339

merged 3 commits into from Jul 27, 2021

Conversation

zakpatterson
Copy link
Contributor

This includes prior commits from 227, and more or less finishes the work of migrating the readme to mdoc with a docusarus site.

To run, this should work:

sbt> docs/mdoc
sbt> docs/docusaurusCreateSite
$ cd website && yarn start

@cornerman cornerman requested a review from fdietze August 22, 2019 15:59
@fdietze
Copy link
Member

fdietze commented Aug 22, 2019

Wow!

Thank you for working on this one. 👍

@zakpatterson
Copy link
Contributor Author

zakpatterson commented Aug 22, 2019

It's by no means complete, I didn't try to scrape and fix the old website code, but i think it's an improvement over the giant readme, and hopefully we can improve the docs incrementally now that it's easier to do so.

@fdietze
Copy link
Member

fdietze commented Aug 23, 2019

I commited some improvements. Unfortunately I'm not able to run docusaurus on NixOS. (It always tries to compile gifsicle, which I have already installed...)

By removing many :shared modifiers, I also encountered this bug: scalameta/mdoc#183

@zakpatterson
Copy link
Contributor Author

Ah yes I ran into that exact error actually, and that's why I just put :shared on everything. Plus I think the default JVM behavior matches the :shared behavior. I wonder why :shared is used in JS but :reset is used in JVM.

@zakpatterson
Copy link
Contributor Author

@fdietze should we put the shareds back or what do you think

docs/readme.md Outdated Show resolved Hide resolved
Copy link
Member

@fdietze fdietze left a comment

Choose a reason for hiding this comment

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

@fdietze should we put the shareds back or what do you think

I think :shared should only used as it was intended. For shared code, such as imports. With the new mdoc release it works without shared.

@@ -1,3930 +0,0 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
Copy link
Member

Choose a reason for hiding this comment

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

why deleting yarn.lock? Probably a mistake...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think we have the need for yarn.lock in the same way js projects do. We don't care about reproducible resolutions of dependencies from npm. I get that's an opinion, but if we leave it then the entire file will change and innocent PRs could create 1000 line diffs, I just don't see the point of having it in this project.

docs/readme.md Outdated Show resolved Hide resolved
@cornerman
Copy link
Member

What is the state here? :)

@fdietze fdietze merged commit 0fc7d57 into outwatch:master Jul 27, 2021
@fdietze
Copy link
Member

fdietze commented Jul 27, 2021

I finally took the time to finish and merge. Also thanks to @zakpatterson !

@zakpatterson zakpatterson deleted the add-fix-mdoc-supersede-277 branch July 27, 2021 12:55
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

3 participants