Greenstand / Greenstand/treetracker-web-map-core
API document to explain how to use web map core
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
We need to sort out and articulate the API document for clients who want to integrate our map.
The document should explain how to use the core, and API of the core, for example: who to jump to a position of the map.
---
Some hints:
- Please read our [readme](https://github.com/Greenstand/treetracker-web-map-core#treetracker-web-map-core) for more information/guide/tutorial.
- Here is [an engineering book](https://greenstand.gitbook.io/engineering/) in Greenstand.
- To know more about our organization, visit our [website](https://greenstand.org).
- If you want to join the slack community (some resources need the community member's permission), please leave your email address.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the repository README and its integration guide, then identify the web map core API entry points used by clients. Document how to integrate the core and how to move the map to a requested position. Done means the API document covers the core usage and includes a clear example for jumping to a map position.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100