Revamp README #442
Draft
Revamp README #442
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`-` in the `files` clause matches a file named `-`. This is probably a mistake.
Use h1 for the title, h2 for sections, h3 for subsections, etc.
- Fix dead links - Improve organization - Update the `using` clause's version - Add a compatability section. One TODO remains. - Make the example more interesting (by introducing an unintentional compilation error)
sorawee
force-pushed
the
revamp-readme
branch
from
c3bbf5b to
c0b63bf
Compare
|
That looks really great - Happy to merge it even if that's not finished. Feel free to remove the Draft status when you feel like ready. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a draft of a README improvement. Right now I only made a pass on the first few sections, but I intend to go through all of them. Eventually, we can also port the README to odoc (as attempted in the stale #355). I submit this a a draft PR now in case anyone would like to provide a feedback.
Intending to resolve: #421, #352, and #273
Help needed
If anyone knows the compatibility of MDX stanza 0.3 (what version of MDX and Dune it works with), please let me know!