Skip to content

Documentation Improvements#992

Closed
JaffaKetchup wants to merge 92 commits intomasterfrom
unknown repository
Closed

Documentation Improvements#992
JaffaKetchup wants to merge 92 commits intomasterfrom
unknown repository

Conversation

@JaffaKetchup
Copy link
Copy Markdown
Member

As discussed in thread #927 (comment), this PR will merge a whole new documentation for flutter_map, including:

  • Improved out-of-code documentation
  • Improved 'dartdoc' (inside code) documentation

themisir and others added 16 commits August 5, 2021 18:15
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
Copy link
Copy Markdown
Contributor

@ibrierley ibrierley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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...

@JaffaKetchup
Copy link
Copy Markdown
Member Author

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.

JaffaKetchup and others added 8 commits April 10, 2022 13:52
* 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
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
Added more prominent links to Discord server
Added `tileBounds`
Replace `bounds` with `maxBounds`
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'
@Malvoz

This comment was marked as resolved.

@JaffaKetchup JaffaKetchup marked this pull request as draft June 18, 2022 17:18
@JaffaKetchup
Copy link
Copy Markdown
Member Author

See #1286.

Thanks to everyone who contributed to the docs, we're glad to see proper documentation available at last!

Special thanks to @themisir and @comatory who worked with me in the temporary docs organisation. Once all is sorted, this organisation will be deleted.

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.

6 participants