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

chore: update documentation #422

Merged
merged 6 commits into from
May 21, 2024
Merged

chore: update documentation #422

merged 6 commits into from
May 21, 2024

Conversation

josxha
Copy link
Collaborator

@josxha josxha commented May 20, 2024

  • update README.md
  • format markdown files

Should probably be only merged shortly before the release because of the changes in how to use the package in an own project.

@josxha josxha requested a review from kuhnroyal May 20, 2024 18:46
@josxha josxha added this to the v0.19.0 milestone May 20, 2024
@josxha josxha self-assigned this May 20, 2024
Copy link
Collaborator

@kuhnroyal kuhnroyal left a 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.

CHANGELOG.md Outdated Show resolved Hide resolved
RELEASE.md Outdated
Copy link
Collaborator

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)
Copy link
Collaborator

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?

Copy link
Collaborator Author

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/

@josxha
Copy link
Collaborator Author

josxha commented May 21, 2024

@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 (:

@kuhnroyal kuhnroyal merged commit a448566 into maplibre:main May 21, 2024
9 checks passed
@kuhnroyal
Copy link
Collaborator

Let's do it, i'll try to push a tag.

@josxha josxha deleted the update-readme branch May 21, 2024 20:16
@josxha
Copy link
Collaborator Author

josxha commented May 21, 2024

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.

Remi-deronzier pushed a commit to viamichelin/flutter-maplibre-gl that referenced this pull request Sep 6, 2024
Remi-deronzier pushed a commit to viamichelin/flutter-maplibre-gl that referenced this pull request Sep 10, 2024
Remi-deronzier pushed a commit to viamichelin/flutter-maplibre-gl that referenced this pull request Sep 10, 2024
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.

2 participants