Documentation Improvements #992
Closed
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
Improve getting-started.md Fix incorrect GitHub links Fix incorrect copyright
Removed docusaurus.config.min.js (no need to minify)
Start of how-does-it-work.md
Added /miscellaneous placeholders for links
Added pub.dev links Added API Reference links Edited landing page to remove placeholder text and add custom text Edited go.md, how-does-it-work.md for general improvements Finished the-basics.md Started options.md
Finish options.md
Finished map-layers.md Finished tile-layer.md Added migration guides
…md & polygon-layer.md Renamed examples.md to master-example.md Started master-example.md Removed repetitive code line from examples throughout Added circle-layer.md
…up-to-date information Added to options.md Added information about performance to marker-layer.md
This was referenced Aug 22, 2021
ibrierley
reviewed
Apr 9, 2022
There was a problem hiding this comment.
I like it overall. One thing I was wondering, is I guess as PR on flutter_map come in, options will be out of date on the docs here ? Could there be a link to either the flutter_dev api or the git code...
Eg if a doc is on tile_layer, is there any way to see this level of detail via a link...
https://pub.dev/documentation/flutter_map/latest/flutter_map.plugin_api/TileLayerOptions-class.html (which may be slightly out of date as well!), just trying to think of ease of access without needing to do too many updates when parameters change etc...
|
I can add links to each page, but not much more than that. In Contributing I have said that they should edit the documentation should they need to. |
* Fix example application (#1213) * Update versions in the example * Remove obsolete splash screen * Added location permission for a live location example * Fix for opacity widget causing hairlines and possible shimmering (#1169) * Fix EPSG4326 parameter difference with Leaflet.js (#1135) * EPSG4326 parameter modification * Add EPSG4326 example page Merge conflicts resolved by: Luka S <github@jaffaketchup.dev> Co-authored-by: Ilya Zverev <ilya@zverev.info> Co-authored-by: Ian <ibrierley@gmail.com> Co-authored-by: yeleibo <sunshineboyye@gmail.com>
Remove duplicate imports in example app Fix missing menu item in drawer in example app
…s/flutter_map into fix-merge-conflicts
Add notices of unfinished documentation to appropriate pages Make writing more concise on many pages Improve landing page Add feedback link to PR Add some content to plugin creation guide
…s/flutter_map into fix-merge-conflicts
Added more prominent links to Discord server Added `tileBounds` Replace `bounds` with `maxBounds`
… fix-merge-conflicts
Update polyline documentation Change navbar external links to more modern icons
Added documentation for polyline calculations Improved documentation about polyline performance issues Improved documentation about polyline format conversion Improved plugins list page Improved consistency betwen \`flutter_map\` and 'flutter_map'
This comment was marked as resolved.
This comment was marked as resolved.
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.
As discussed in thread #927 (comment), this PR will merge a whole new documentation for
flutter_map, including: