-
Notifications
You must be signed in to change notification settings - Fork 117
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
chore: update documentation #422
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One bad format needs fixing.
RELEASE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content here is outdated but we can update that once we know the new release workflow actually works.
@@ -1,50 +1,69 @@ | |||
# Flutter Maplibre GL | |||
[![Flutter CI](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/flutter_ci.yml/badge.svg)](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/flutter_ci.yml) | |||
[![Generate docs](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/generate_docs.yml/badge.svg)](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/generate_docs.yml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we keep these badges, additionally to the new ones?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed them because both information is not really usefull for users when they view the package on pub.dev.
The Flutter CI workflow runs for commits made to pull requests too, right?
Additionally I'd like to remove the docs generation in the future because the links in the right side bar are broken: https://htmlpreview.github.io/?https://github.com/m0nac0/flutter-maplibre-gl/docs/doc/api/index.html. We can just use the hosted API docs from pub.dev: https://pub.dev/documentation/maplibre_gl/latest/
@kuhnroyal I worked through the commit history and added them to the changelog. Take a look and if you want we can try to release today (: |
Let's do it, i'll try to push a tag. |
I tested the publish process on my fork and experienced some syntax errors. 🥲 I'll open a pr to (hopefully) fix them in a bit. |
Should probably be only merged shortly before the release because of the changes in how to use the package in an own project.