Skip to content

Commit

Permalink
README: improve link to guide (#237)
Browse files Browse the repository at this point in the history
Linking scala-yaml/ lands the user at the API index, where one can
easily index that there is a "Docs" button which is the guide. Linking
to scala-yaml/docs/ instead, links to the "Docs" instead.
  • Loading branch information
Flowdalic committed Aug 17, 2023
1 parent 9054aff commit e5c260a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The goal of this project is to create idiomatic library which:
* have explicit error handling and helpful error messages
* cross compiles to [Scala.js](http://www.scala-js.org/) and [Scala Native](https://github.com/scala-native/scala-native) (waiting for Scala 3 support in SN)

Please see the [guide](https://virtuslab.github.io/scala-yaml/) for more information
Please see the [guide](https://virtuslab.github.io/scala-yaml/docs/) for more information

# Help us create our roadmap!
Take part in our [discussions](https://github.com/VirtusLab/scala-yaml/discussions), post your ideas, vote for feature requests and have a real impact on how our next milestone will look like!
Expand Down

0 comments on commit e5c260a

Please sign in to comment.